控制台通知 [console.openshift.io/v1] - 控制台 API | API 参考 | OpenShift 容器平台 4.17

规格
- .spec
- .spec.link
API端点

描述

ConsoleNotification是用于配置openshift Web控制台通知的扩展。兼容性级别2：在主要版本中至少稳定9个月或3个次要版本（以较长者为准）。

类型

对象

必需

spec

规范

属性类型描述

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义了此对象表示的版本化模式。服务器应将识别的模式转换为最新的内部值，并可能拒绝无法识别的值。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	Kind 是一个字符串值，表示此对象代表的 REST 资源。服务器可以从客户端提交请求的端点推断出这一点。无法更新。使用驼峰命名法。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	标准对象的元数据。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`对象`	ConsoleNotificationSpec 是所需的控制台通知配置。

apiVersion

字符串

APIVersion 定义了此对象表示的版本化模式。服务器应将识别的模式转换为最新的内部值，并可能拒绝无法识别的值。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

字符串

Kind 是一个字符串值，表示此对象代表的 REST 资源。服务器可以从客户端提交请求的端点推断出这一点。无法更新。使用驼峰命名法。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

标准对象的元数据。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

对象

ConsoleNotificationSpec 是所需的控制台通知配置。

.spec

描述

ConsoleNotificationSpec 是所需的控制台通知配置。

类型

对象

必需

文本

属性类型描述

属性	类型	描述
`backgroundColor`	`字符串`	backgroundColor 是通知背景颜色，采用 CSS 颜色数据类型。
`color`	`字符串`	color 是通知文本颜色，采用 CSS 颜色数据类型。
`link`	`对象`	link 是一个包含通知链接详细信息的对象。
`location`	`字符串`	location 是控制台中通知的位置。有效值为：“BannerTop”、“BannerBottom”、“BannerTopBottom”。
`文本`	`字符串`	text 是通知的可见文本。

backgroundColor

字符串

backgroundColor 是通知背景颜色，采用 CSS 颜色数据类型。

color

字符串

color 是通知文本颜色，采用 CSS 颜色数据类型。

link

对象

link 是一个包含通知链接详细信息的对象。

location

字符串

location 是控制台中通知的位置。有效值为：“BannerTop”、“BannerBottom”、“BannerTopBottom”。

文本

字符串

text 是通知的可见文本。

.spec.link

描述

link 是一个包含通知链接详细信息的对象。

类型

对象

必需

href
文本

属性类型描述

属性	类型	描述
`href`	`字符串`	href 是链接的绝对安全 URL（必须使用 https）
`文本`	`字符串`	text 是链接的显示文本

href

字符串

href 是链接的绝对安全 URL（必须使用 https）

文本

字符串

text 是链接的显示文本

API 端点

提供以下 API 端点

/apis/console.openshift.io/v1/consolenotifications
- DELETE：删除 ConsoleNotification 集合
- GET：列出 ConsoleNotification 类型的对象
- POST：创建一个 ConsoleNotification
/apis/console.openshift.io/v1/consolenotifications/{name}
- DELETE：删除一个 ConsoleNotification
- GET：读取指定的 ConsoleNotification
- PATCH：部分更新指定的 ConsoleNotification
- PUT：替换指定的 ConsoleNotification
/apis/console.openshift.io/v1/consolenotifications/{name}/status
- GET：读取指定的 ConsoleNotification 的状态
- PATCH：部分更新指定的 ConsoleNotification 的状态
- PUT：替换指定的 ConsoleNotification 的状态

/apis/console.openshift.io/v1/consolenotifications

HTTP 方法: DELETE
描述: 删除 ConsoleNotification 集合

表 1. HTTP 响应
HTTP 代码	响应体
200 - OK	`Status` 模式
401 - 未授权	空

HTTP 方法: GET
描述: 列出 ConsoleNotification 类型的对象

表 2. HTTP 响应
HTTP 代码	响应体
200 - OK	`ConsoleNotificationList` 模式
401 - 未授权	空

HTTP 方法: POST
描述: 创建一个 ConsoleNotification

表 3. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何从对象中静默删除的未知字段，并将忽略解码器遇到的所有重复字段中的最后一个字段以外的所有字段。这是 v1.23 之前的默认行为。- Warn：对于从对象中删除的每个未知字段以及遇到的每个重复字段，这都将通过标准警告响应标头发送警告。如果没有任何其他错误，请求仍然会成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并出现 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 4. 请求体参数
参数	类型	描述
`body`	`ConsoleNotification` 模式

表 5. HTTP 响应
HTTP 代码	响应体
200 - OK	`ConsoleNotification` 模式
201 - 已创建	`ConsoleNotification` 模式
202 - 已接受	`ConsoleNotification` 模式
401 - 未授权	空

/apis/console.openshift.io/v1/consolenotifications/{name}

表 6. 全局路径参数
参数	类型	描述
`name`	`字符串`	ConsoleNotification 的名称

HTTP 方法: DELETE
描述: 删除一个 ConsoleNotification

表 7. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

表 8. HTTP 响应
HTTP 代码	响应体
200 - OK	`Status` 模式
202 - 已接受	`Status` 模式
401 - 未授权	空

HTTP 方法: GET
描述: 读取指定的 ConsoleNotification

表 9. HTTP 响应
HTTP 代码	响应体
200 - OK	`ConsoleNotification` 模式
401 - 未授权	空

HTTP 方法: PATCH
描述: 部分更新指定的 ConsoleNotification

表 10. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何从对象中静默删除的未知字段，并将忽略解码器遇到的所有重复字段中的最后一个字段以外的所有字段。这是 v1.23 之前的默认行为。- Warn：对于从对象中删除的每个未知字段以及遇到的每个重复字段，这都将通过标准警告响应标头发送警告。如果没有任何其他错误，请求仍然会成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并出现 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 11. HTTP 响应
HTTP 代码	响应体
200 - OK	`ConsoleNotification` 模式
401 - 未授权	空

HTTP 方法: PUT
描述: 替换指定的 ConsoleNotification

表 12. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何从对象中静默删除的未知字段，并将忽略解码器遇到的所有重复字段中的最后一个字段以外的所有字段。这是 v1.23 之前的默认行为。- Warn：对于从对象中删除的每个未知字段以及遇到的每个重复字段，这都将通过标准警告响应标头发送警告。如果没有任何其他错误，请求仍然会成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并出现 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 13. 请求体参数
参数	类型	描述
`body`	`ConsoleNotification` 模式

表 14. HTTP 响应
HTTP 代码	响应体
200 - OK	`ConsoleNotification` 模式
201 - 已创建	`ConsoleNotification` 模式
401 - 未授权	空

/apis/console.openshift.io/v1/consolenotifications/{name}/status

表 15. 全局路径参数
参数	类型	描述
`name`	`字符串`	ConsoleNotification 的名称

HTTP 方法: GET
描述: 读取指定的 ConsoleNotification 的状态

表 16. HTTP 响应
HTTP 代码	响应体
200 - OK	`ConsoleNotification` 模式
401 - 未授权	空

HTTP 方法: PATCH
描述: 部分更新指定的 ConsoleNotification 的状态

表 17. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何从对象中静默删除的未知字段，并将忽略解码器遇到的所有重复字段中的最后一个字段以外的所有字段。这是 v1.23 之前的默认行为。- Warn：对于从对象中删除的每个未知字段以及遇到的每个重复字段，这都将通过标准警告响应标头发送警告。如果没有任何其他错误，请求仍然会成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并出现 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 18. HTTP 响应
HTTP 代码	响应体
200 - OK	`ConsoleNotification` 模式
401 - 未授权	空

HTTP 方法: PUT
描述: 替换指定的 ConsoleNotification 的状态

表 19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何从对象中静默删除的未知字段，并将忽略解码器遇到的所有重复字段中的最后一个字段以外的所有字段。这是 v1.23 之前的默认行为。- Warn：对于从对象中删除的每个未知字段以及遇到的每个重复字段，这都将通过标准警告响应标头发送警告。如果没有任何其他错误，请求仍然会成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并出现 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 20. 请求体参数
参数	类型	描述
`body`	`ConsoleNotification` 模式

表 21. HTTP 响应
HTTP 代码	响应体
200 - OK	`ConsoleNotification` 模式
201 - 已创建	`ConsoleNotification` 模式
401 - 未授权	空