控制台 API

第 1 章控制台 API

1.1. ConsoleCLIDownload [console.openshift.io/v1]

描述: ConsoleCLIDownload 是配置 openshift web 控制台命令行界面(CLI)下载的扩展。兼容性级别 2：在主发行版本中至少为 9 个月或 3 个次版本（以更长的时间为准）。
类型: 对象

1.2. ConsoleExternalLogLink [console.openshift.io/v1]

描述: ConsoleExternalLogLink 是自定义 OpenShift Web 控制台日志链接的扩展。兼容性级别 2：在主发行版本中至少为 9 个月或 3 个次版本（以更长的时间为准）。
类型: 对象

1.3. ConsoleLink [console.openshift.io/v1]

描述: ConsoleLink 是自定义 OpenShift Web 控制台链接的扩展。兼容性级别 2：在主发行版本中至少为 9 个月或 3 个次版本（以更长的时间为准）。
类型: 对象

1.4. ConsoleNotification [console.openshift.io/v1]

描述: ConsoleNotification 是配置 openshift web 控制台通知的扩展。兼容性级别 2：在主发行版本中至少为 9 个月或 3 个次版本（以更长的时间为准）。
类型: object

1.5. ConsolePlugin [console.openshift.io/v1]

描述: consolePlugin 是一个扩展，可通过从集群中运行的另一个服务动态加载代码来自定义 OpenShift Web 控制台。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
类型: 对象

1.6. ConsoleQuickStart [console.openshift.io/v1]

描述: ConsoleQuickStart 是通过 OpenShift Web 控制台中的各种工作流调整用户的扩展。兼容性级别 2：在主发行版本中至少为 9 个月或 3 个次版本（以更长的时间为准）。
类型: 对象

1.7. ConsoleYAMLSample [console.openshift.io/v1]

描述: ConsoleYAMLSample 是自定义 OpenShift Web 控制台 YAML 样本的扩展。兼容性级别 2：在主发行版本中至少为 9 个月或 3 个次版本（以更长的时间为准）。
类型: 对象

第 2 章 ConsoleCLIDownload [console.openshift.io/v1]

描述

ConsoleCLIDownload 是配置 openshift web 控制台命令行界面(CLI)下载的扩展。兼容性级别 2：在主发行版本中至少为 9 个月或 3 个次版本（以更长的时间为准）。

类型

object

必填

spec

2.1. 规格

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： 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`	`对象`	ConsoleCLIDownloadSpec 是所需的 cli 下载配置。

2.1.1. .spec

描述

ConsoleCLIDownloadSpec 是所需的 cli 下载配置。

类型

object

必填

description
displayName
links

属性	类型	描述
`description`	`字符串`	description 是 CLI 下载的描述(can include markdown)。
`displayName`	`字符串`	displayName 是 CLI 下载的显示名称。
`links`	`array`	links 是提供 CLI 下载链接详细信息的对象列表。
`links[]`	`对象`

2.1.2. .spec.links

描述: links 是提供 CLI 下载链接详细信息的对象列表。
类型: array

2.1.3. .spec.links[]

描述

类型

object

必填

href

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

2.2. API 端点

可用的 API 端点如下：

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

2.2.1. /apis/console.openshift.io/v1/consoleclidownloads

表 2.1. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

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

表 2.2. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`sendInitialEvents`	`布尔值`	`sendInitialEvents=true` 可以和 `watch=true` 一起设置。在这种情况下，观察流将以复合事件开头，以生成集合中对象的当前状态。发送完所有这些事件后，将发送合成"Bookmark"事件。书签将报告与对象集合对应的 ResourceVersion (RV)，并使用 `"k8s.io/initial-events-end": "true"` 注解进行标记。之后，监视流将照常进行，从而向监视的对象发送与更改对应的监视事件（按 RV 排序）。当设置 `sendInitialEvents` 选项时，我们还需要设置 `resourceVersionMatch` 选项。监控请求的语义如下： - `resourceVersionMatch` = NotOlderThan 解释为"数据至少为提供的 `resourceVersion'"，当状态同步到 'resourceVersion 时，如果状态同步到 ListOptions 提供的 'resourceVersion 时，会发送书签事件`。如果未设置 `resourceVersion`，则这被解释为"consistent read"，当请求开始处理时，将发送书签事件。- `resourceVersionMatch` 设置为任何其他值或未设置 Invalid 错误。如果 `resourceVersion=""` 或 `resourceVersion="0"` （出于向后兼容原因）和 false，则默认为 true。
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

表 2.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

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

表 2.4. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`sendInitialEvents`	`布尔值`	`sendInitialEvents=true` 可以和 `watch=true` 一起设置。在这种情况下，观察流将以复合事件开头，以生成集合中对象的当前状态。发送完所有这些事件后，将发送合成"Bookmark"事件。书签将报告与对象集合对应的 ResourceVersion (RV)，并使用 `"k8s.io/initial-events-end": "true"` 注解进行标记。之后，监视流将照常进行，从而向监视的对象发送与更改对应的监视事件（按 RV 排序）。当设置 `sendInitialEvents` 选项时，我们还需要设置 `resourceVersionMatch` 选项。监控请求的语义如下： - `resourceVersionMatch` = NotOlderThan 解释为"数据至少为提供的 `resourceVersion'"，当状态同步到 'resourceVersion 时，如果状态同步到 ListOptions 提供的 'resourceVersion 时，会发送书签事件`。如果未设置 `resourceVersion`，则这被解释为"consistent read"，当请求开始处理时，将发送书签事件。- `resourceVersionMatch` 设置为任何其他值或未设置 Invalid 错误。如果 `resourceVersion=""` 或 `resourceVersion="0"` （出于向后兼容原因）和 false，则默认为 true。
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

表 2.5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleCLIDownloadList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 ConsoleCLIDownload

表 2.6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 2.7. 主体参数
参数	类型	描述
`正文（body）`	`ConsoleCLIDownload` 模式

表 2.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleCLIDownload` 模式
201 - Created	`ConsoleCLIDownload` 模式
202 - Accepted	`ConsoleCLIDownload` 模式
401 - Unauthorized	空

2.2.2. /apis/console.openshift.io/v1/consoleclidownloads/{name}

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

表 2.10. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除 ConsoleCLIDownload

表 2.11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`orphanDependents`	`布尔值`	弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。
`propagationPolicy`	`字符串`	是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。

表 2.12. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions` 模式

表 2.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 阅读指定的 ConsoleCLIDownload

表 2.14. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

表 2.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleCLIDownload` 模式
401 - Unauthorized	空

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

表 2.16. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求(application/apply-patch)需要此字段，但对非应用补丁类型(JsonPatch、MergePatch、MergePatch)是可选的。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。
`force`	`布尔值`	强制要"强制"应用请求。这意味着用户将重新分配由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。

表 2.17. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

表 2.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleCLIDownload` 模式
401 - Unauthorized	空

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

表 2.19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 2.20. 主体参数
参数	类型	描述
`正文（body）`	`ConsoleCLIDownload` 模式

表 2.21. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleCLIDownload` 模式
201 - Created	`ConsoleCLIDownload` 模式
401 - Unauthorized	空

2.2.3. /apis/console.openshift.io/v1/consoleclidownloads/{name}/status

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

表 2.23. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

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

表 2.24. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

表 2.25. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleCLIDownload` 模式
401 - Unauthorized	空

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

表 2.26. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求(application/apply-patch)需要此字段，但对非应用补丁类型(JsonPatch、MergePatch、MergePatch)是可选的。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。
`force`	`布尔值`	强制要"强制"应用请求。这意味着用户将重新分配由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。

表 2.27. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

表 2.28. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleCLIDownload` 模式
401 - Unauthorized	空

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

表 2.29. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 2.30. 主体参数
参数	类型	描述
`正文（body）`	`ConsoleCLIDownload` 模式

表 2.31. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleCLIDownload` 模式
201 - Created	`ConsoleCLIDownload` 模式
401 - Unauthorized	空

第 3 章 ConsoleExternalLogLink [console.openshift.io/v1]

描述

ConsoleExternalLogLink 是自定义 OpenShift Web 控制台日志链接的扩展。兼容性级别 2：在主发行版本中至少为 9 个月或 3 个次版本（以更长的时间为准）。

类型

object

必填

spec

3.1. 规格

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： 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`	`对象`	ConsoleExternalLogLinkSpec 是所需的日志链接配置。日志链接将显示在 Pod 详情页面的 logs 选项卡中。

3.1.1. .spec

描述

ConsoleExternalLogLinkSpec 是所需的日志链接配置。日志链接将显示在 Pod 详情页面的 logs 选项卡中。

类型

object

必填

hrefTemplate
text

属性	类型	描述
`hrefTemplate`	`字符串`	hrefTemplate 是一个绝对安全 URL （必须使用 https），用于日志链接，包括要替换的变量。在 URL 中指定变量，格式为 ${variableName}，例如 ${containerName}，并将替换为资源中的对应值。资源是一个 pod。支持的变量有： - ${resourceName} - 包含日志的资源的名称 - ${resourceUID} - 包含日志的 UID - 例如 `11111111-2222-3333-4444-555555555555` 55555555555555555555- ${containerName} - 包含 logs - ${resourceNamespace} 的资源容器的名称 - 包含日志的资源的命名空间 - ${resourceNamespaceUID} - 包含日志的资源的命名空间 UID - ${podLabels} - 与日志匹配的标签的 JSON 表示 - `例如 {"key1":"value1","key2":"value2` "} e.g . https://example.com/logs?resourceName=${resourceName}&containerName=${containerName}&resourceNamespace=${resourceNamespace}&podLabels=${podLabels}
`namespaceFilter`	`字符串`	namespaceFilter 是一个正则表达式，用于限制与一组匹配的命名空间（如 `^openshift-`）的日志链接。使用 JavaScript RegExp constructor 将字符串转换为正则表达式。如果没有指定，则会显示所有命名空间的链接。
`text`	`字符串`	文本是链接的显示文本

3.2. API 端点

可用的 API 端点如下：

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

3.2.1. /apis/console.openshift.io/v1/consoleexternalloglinks

表 3.1. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

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

表 3.2. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`sendInitialEvents`	`布尔值`	`sendInitialEvents=true` 可以和 `watch=true` 一起设置。在这种情况下，观察流将以复合事件开头，以生成集合中对象的当前状态。发送完所有这些事件后，将发送合成"Bookmark"事件。书签将报告与对象集合对应的 ResourceVersion (RV)，并使用 `"k8s.io/initial-events-end": "true"` 注解进行标记。之后，监视流将照常进行，从而向监视的对象发送与更改对应的监视事件（按 RV 排序）。当设置 `sendInitialEvents` 选项时，我们还需要设置 `resourceVersionMatch` 选项。监控请求的语义如下： - `resourceVersionMatch` = NotOlderThan 解释为"数据至少为提供的 `resourceVersion'"，当状态同步到 'resourceVersion 时，如果状态同步到 ListOptions 提供的 'resourceVersion 时，会发送书签事件`。如果未设置 `resourceVersion`，则这被解释为"consistent read"，当请求开始处理时，将发送书签事件。- `resourceVersionMatch` 设置为任何其他值或未设置 Invalid 错误。如果 `resourceVersion=""` 或 `resourceVersion="0"` （出于向后兼容原因）和 false，则默认为 true。
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

表 3.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

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

表 3.4. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`sendInitialEvents`	`布尔值`	`sendInitialEvents=true` 可以和 `watch=true` 一起设置。在这种情况下，观察流将以复合事件开头，以生成集合中对象的当前状态。发送完所有这些事件后，将发送合成"Bookmark"事件。书签将报告与对象集合对应的 ResourceVersion (RV)，并使用 `"k8s.io/initial-events-end": "true"` 注解进行标记。之后，监视流将照常进行，从而向监视的对象发送与更改对应的监视事件（按 RV 排序）。当设置 `sendInitialEvents` 选项时，我们还需要设置 `resourceVersionMatch` 选项。监控请求的语义如下： - `resourceVersionMatch` = NotOlderThan 解释为"数据至少为提供的 `resourceVersion'"，当状态同步到 'resourceVersion 时，如果状态同步到 ListOptions 提供的 'resourceVersion 时，会发送书签事件`。如果未设置 `resourceVersion`，则这被解释为"consistent read"，当请求开始处理时，将发送书签事件。- `resourceVersionMatch` 设置为任何其他值或未设置 Invalid 错误。如果 `resourceVersion=""` 或 `resourceVersion="0"` （出于向后兼容原因）和 false，则默认为 true。
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

表 3.5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleExternalLogLinkList` schema
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 ConsoleExternalLogLink

表 3.6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 3.7. 主体参数
参数	类型	描述
`正文（body）`	`ConsoleExternalLogLink` schema

表 3.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleExternalLogLink` schema
201 - Created	`ConsoleExternalLogLink` schema
202 - Accepted	`ConsoleExternalLogLink` schema
401 - Unauthorized	空

3.2.2. /apis/console.openshift.io/v1/consoleexternalloglinks/{name}

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

表 3.10. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: delete a ConsoleExternalLogLink

表 3.11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`orphanDependents`	`布尔值`	弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。
`propagationPolicy`	`字符串`	是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。

表 3.12. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions` 模式

表 3.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 阅读指定的 ConsoleExternalLogLink

表 3.14. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

表 3.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleExternalLogLink` schema
401 - Unauthorized	空

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

表 3.16. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求(application/apply-patch)需要此字段，但对非应用补丁类型(JsonPatch、MergePatch、MergePatch)是可选的。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。
`force`	`布尔值`	强制要"强制"应用请求。这意味着用户将重新分配由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。

表 3.17. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

表 3.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleExternalLogLink` schema
401 - Unauthorized	空

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

表 3.19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 3.20. 主体参数
参数	类型	描述
`正文（body）`	`ConsoleExternalLogLink` schema

表 3.21. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleExternalLogLink` schema
201 - Created	`ConsoleExternalLogLink` schema
401 - Unauthorized	空

3.2.3. /apis/console.openshift.io/v1/consoleexternalloglinks/{name}/status

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

表 3.23. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

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

表 3.24. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

表 3.25. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleExternalLogLink` schema
401 - Unauthorized	空

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

表 3.26. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求(application/apply-patch)需要此字段，但对非应用补丁类型(JsonPatch、MergePatch、MergePatch)是可选的。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。
`force`	`布尔值`	强制要"强制"应用请求。这意味着用户将重新分配由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。

表 3.27. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

表 3.28. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleExternalLogLink` schema
401 - Unauthorized	空

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

表 3.29. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 3.30. 主体参数
参数	类型	描述
`正文（body）`	`ConsoleExternalLogLink` schema

表 3.31. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleExternalLogLink` schema
201 - Created	`ConsoleExternalLogLink` schema
401 - Unauthorized	空

第 4 章 ConsoleLink [console.openshift.io/v1]

描述

ConsoleLink 是自定义 OpenShift Web 控制台链接的扩展。兼容性级别 2：在主发行版本中至少为 9 个月或 3 个次版本（以更长的时间为准）。

类型

object

必填

spec

4.1. 规格

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： 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`	`对象`	ConsoleLinkSpec 是所需的控制台链接配置。

4.1.1. .spec

描述

ConsoleLinkSpec 是所需的控制台链接配置。

类型

object

必填

href
位置
text

属性	类型	描述
`applicationMenu`	`对象`	ApplicationMenu 包含有关应用程序菜单中链接要使用的部分和图标的信息，且仅在位置设置为 ApplicationMenu 时才适用。
`href`	`字符串`	href 是链接的绝对安全 URL （必须使用 https）
`位置`	`字符串`	位置决定将把链接附加到的控制台中的哪个位置(ApplicationMenu、HelpMenu、UserMenu、NamespaceDashboard)。
`namespaceDashboard`	`对象`	namespaceDashboard 包含有关应当在其中显示仪表板链接的命名空间的信息，且仅在位置设置为 NamespaceDashboard 时才适用。如果未指定，则链接将出现在所有命名空间中。
`text`	`字符串`	文本是链接的显示文本

4.1.2. .spec.applicationMenu

描述

ApplicationMenu 包含有关应用程序菜单中链接要使用的部分和图标的信息，且仅在位置设置为 ApplicationMenu 时才适用。

类型

object

必填

节

属性	类型	描述
`imageURL`	`字符串`	imageURL 是应用程序菜单中链接前面使用的图标的 URL。URL 必须是 HTTPS URL 或数据 URI。该镜像应该为方括号，并将显示在 24x24 像素。
`节`	`字符串`	部分是应该在其中显示链接的应用程序菜单的部分。这可以是应用程序菜单中显示为子标题的任何文本。如果文本与现有部分的文本不匹配，则会创建一个新部分。

4.1.3. .spec.namespaceDashboard

描述: namespaceDashboard 包含有关应当在其中显示仪表板链接的命名空间的信息，且仅在位置设置为 NamespaceDashboard 时才适用。如果未指定，则链接将出现在所有命名空间中。
类型: object

属性	类型	描述
`namespaceSelector`	`对象`	namespaceSelector 用于选择应该包含仪表板链接的命名空间。如果命名空间标签匹配，则会显示命名空间的仪表板链接。
`命名空间`	`数组（字符串）`	namespaces 是应在其中显示仪表板链接的命名空间名称的数组。

4.1.4. .spec.namespaceDashboard.namespaceSelector

描述: namespaceSelector 用于选择应该包含仪表板链接的命名空间。如果命名空间标签匹配，则会显示命名空间的仪表板链接。
类型: object

属性	类型	描述
`matchExpressions`	`array`	matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
`matchExpressions[]`	`对象`	标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
`matchLabels`	`对象（字符串）`	matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素，其 key 字段是 "key"，运算符是 "In"，值数组仅包含 "value"。要求的逻辑关系是 AND。

4.1.5. .spec.namespaceDashboard.namespaceSelector.matchExpressions

描述: matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
类型: array

4.1.6. .spec.namespaceDashboard.namespaceSelector.matchExpressions[]

描述

标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。

类型

object

必填

key
operator

属性	类型	描述
`key`	`字符串`	key 是选择器应用到的标签键。
`operator`	`字符串`	运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。
`值`	`数组（字符串）`	值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。这个数组会在策略性合并补丁中被替换。

4.2. API 端点

可用的 API 端点如下：

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

4.2.1. /apis/console.openshift.io/v1/consolelinks

表 4.1. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

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

表 4.2. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`sendInitialEvents`	`布尔值`	`sendInitialEvents=true` 可以和 `watch=true` 一起设置。在这种情况下，观察流将以复合事件开头，以生成集合中对象的当前状态。发送完所有这些事件后，将发送合成"Bookmark"事件。书签将报告与对象集合对应的 ResourceVersion (RV)，并使用 `"k8s.io/initial-events-end": "true"` 注解进行标记。之后，监视流将照常进行，从而向监视的对象发送与更改对应的监视事件（按 RV 排序）。当设置 `sendInitialEvents` 选项时，我们还需要设置 `resourceVersionMatch` 选项。监控请求的语义如下： - `resourceVersionMatch` = NotOlderThan 解释为"数据至少为提供的 `resourceVersion'"，当状态同步到 'resourceVersion 时，如果状态同步到 ListOptions 提供的 'resourceVersion 时，会发送书签事件`。如果未设置 `resourceVersion`，则这被解释为"consistent read"，当请求开始处理时，将发送书签事件。- `resourceVersionMatch` 设置为任何其他值或未设置 Invalid 错误。如果 `resourceVersion=""` 或 `resourceVersion="0"` （出于向后兼容原因）和 false，则默认为 true。
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

表 4.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出 kind ConsoleLink 的对象

表 4.4. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`sendInitialEvents`	`布尔值`	`sendInitialEvents=true` 可以和 `watch=true` 一起设置。在这种情况下，观察流将以复合事件开头，以生成集合中对象的当前状态。发送完所有这些事件后，将发送合成"Bookmark"事件。书签将报告与对象集合对应的 ResourceVersion (RV)，并使用 `"k8s.io/initial-events-end": "true"` 注解进行标记。之后，监视流将照常进行，从而向监视的对象发送与更改对应的监视事件（按 RV 排序）。当设置 `sendInitialEvents` 选项时，我们还需要设置 `resourceVersionMatch` 选项。监控请求的语义如下： - `resourceVersionMatch` = NotOlderThan 解释为"数据至少为提供的 `resourceVersion'"，当状态同步到 'resourceVersion 时，如果状态同步到 ListOptions 提供的 'resourceVersion 时，会发送书签事件`。如果未设置 `resourceVersion`，则这被解释为"consistent read"，当请求开始处理时，将发送书签事件。- `resourceVersionMatch` 设置为任何其他值或未设置 Invalid 错误。如果 `resourceVersion=""` 或 `resourceVersion="0"` （出于向后兼容原因）和 false，则默认为 true。
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

表 4.5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleLinkList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 ConsoleLink

表 4.6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 4.7. 主体参数
参数	类型	描述
`正文（body）`	`ConsoleLink` 模式

表 4.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleLink` 模式
201 - Created	`ConsoleLink` 模式
202 - Accepted	`ConsoleLink` 模式
401 - Unauthorized	空

4.2.2. /apis/console.openshift.io/v1/consolelinks/{name}

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

表 4.10. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除 ConsoleLink

表 4.11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`orphanDependents`	`布尔值`	弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。
`propagationPolicy`	`字符串`	是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。

表 4.12. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions` 模式

表 4.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 阅读指定的 ConsoleLink

表 4.14. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

表 4.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleLink` 模式
401 - Unauthorized	空

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

表 4.16. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求(application/apply-patch)需要此字段，但对非应用补丁类型(JsonPatch、MergePatch、MergePatch)是可选的。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。
`force`	`布尔值`	强制要"强制"应用请求。这意味着用户将重新分配由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。

表 4.17. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

表 4.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleLink` 模式
401 - Unauthorized	空

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

表 4.19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 4.20. 主体参数
参数	类型	描述
`正文（body）`	`ConsoleLink` 模式

表 4.21. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleLink` 模式
201 - Created	`ConsoleLink` 模式
401 - Unauthorized	空

4.2.3. /apis/console.openshift.io/v1/consolelinks/{name}/status

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

表 4.23. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

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

表 4.24. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

表 4.25. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleLink` 模式
401 - Unauthorized	空

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

表 4.26. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求(application/apply-patch)需要此字段，但对非应用补丁类型(JsonPatch、MergePatch、MergePatch)是可选的。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。
`force`	`布尔值`	强制要"强制"应用请求。这意味着用户将重新分配由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。

表 4.27. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

表 4.28. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleLink` 模式
401 - Unauthorized	空

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

表 4.29. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 4.30. 主体参数
参数	类型	描述
`正文（body）`	`ConsoleLink` 模式

表 4.31. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleLink` 模式
201 - Created	`ConsoleLink` 模式
401 - Unauthorized	空

第 5 章 ConsoleNotification [console.openshift.io/v1]

描述

ConsoleNotification 是配置 openshift web 控制台通知的扩展。兼容性级别 2：在主发行版本中至少为 9 个月或 3 个次版本（以更长的时间为准）。

类型

object

必填

spec

5.1. 规格

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： 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 是所需的控制台通知配置。

5.1.1. .spec

描述

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

类型

object

必填

text

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

5.1.2. .spec.link

描述

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

类型

object

必填

href
text

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

5.2. API 端点

可用的 API 端点如下：

/apis/console.openshift.io/v1/consolenotifications
- DELETE ：删除 ConsoleNotification 集合
- GET: 列出 kind 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 的状态

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

表 5.1. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

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

表 5.2. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`sendInitialEvents`	`布尔值`	`sendInitialEvents=true` 可以和 `watch=true` 一起设置。在这种情况下，观察流将以复合事件开头，以生成集合中对象的当前状态。发送完所有这些事件后，将发送合成"Bookmark"事件。书签将报告与对象集合对应的 ResourceVersion (RV)，并使用 `"k8s.io/initial-events-end": "true"` 注解进行标记。之后，监视流将照常进行，从而向监视的对象发送与更改对应的监视事件（按 RV 排序）。当设置 `sendInitialEvents` 选项时，我们还需要设置 `resourceVersionMatch` 选项。监控请求的语义如下： - `resourceVersionMatch` = NotOlderThan 解释为"数据至少为提供的 `resourceVersion'"，当状态同步到 'resourceVersion 时，如果状态同步到 ListOptions 提供的 'resourceVersion 时，会发送书签事件`。如果未设置 `resourceVersion`，则这被解释为"consistent read"，当请求开始处理时，将发送书签事件。- `resourceVersionMatch` 设置为任何其他值或未设置 Invalid 错误。如果 `resourceVersion=""` 或 `resourceVersion="0"` （出于向后兼容原因）和 false，则默认为 true。
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

表 5.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

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

表 5.4. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`sendInitialEvents`	`布尔值`	`sendInitialEvents=true` 可以和 `watch=true` 一起设置。在这种情况下，观察流将以复合事件开头，以生成集合中对象的当前状态。发送完所有这些事件后，将发送合成"Bookmark"事件。书签将报告与对象集合对应的 ResourceVersion (RV)，并使用 `"k8s.io/initial-events-end": "true"` 注解进行标记。之后，监视流将照常进行，从而向监视的对象发送与更改对应的监视事件（按 RV 排序）。当设置 `sendInitialEvents` 选项时，我们还需要设置 `resourceVersionMatch` 选项。监控请求的语义如下： - `resourceVersionMatch` = NotOlderThan 解释为"数据至少为提供的 `resourceVersion'"，当状态同步到 'resourceVersion 时，如果状态同步到 ListOptions 提供的 'resourceVersion 时，会发送书签事件`。如果未设置 `resourceVersion`，则这被解释为"consistent read"，当请求开始处理时，将发送书签事件。- `resourceVersionMatch` 设置为任何其他值或未设置 Invalid 错误。如果 `resourceVersion=""` 或 `resourceVersion="0"` （出于向后兼容原因）和 false，则默认为 true。
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

表 5.5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleNotificationList` schema
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 ConsoleNotification

表 5.6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 5.7. 主体参数
参数	类型	描述
`正文（body）`	`ConsoleNotification` 模式

表 5.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleNotification` 模式
201 - Created	`ConsoleNotification` 模式
202 - Accepted	`ConsoleNotification` 模式
401 - Unauthorized	空

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

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

表 5.10. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除 ConsoleNotification

表 5.11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`orphanDependents`	`布尔值`	弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。
`propagationPolicy`	`字符串`	是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。

表 5.12. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions` 模式

表 5.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

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

表 5.14. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

表 5.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleNotification` 模式
401 - Unauthorized	空

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

表 5.16. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求(application/apply-patch)需要此字段，但对非应用补丁类型(JsonPatch、MergePatch、MergePatch)是可选的。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。
`force`	`布尔值`	强制要"强制"应用请求。这意味着用户将重新分配由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。

表 5.17. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

表 5.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleNotification` 模式
401 - Unauthorized	空

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

表 5.19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 5.20. 主体参数
参数	类型	描述
`正文（body）`	`ConsoleNotification` 模式

表 5.21. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleNotification` 模式
201 - Created	`ConsoleNotification` 模式
401 - Unauthorized	空

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

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

表 5.23. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

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

表 5.24. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

表 5.25. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleNotification` 模式
401 - Unauthorized	空

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

表 5.26. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求(application/apply-patch)需要此字段，但对非应用补丁类型(JsonPatch、MergePatch、MergePatch)是可选的。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。
`force`	`布尔值`	强制要"强制"应用请求。这意味着用户将重新分配由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。

表 5.27. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

表 5.28. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleNotification` 模式
401 - Unauthorized	空

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

表 5.29. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 5.30. 主体参数
参数	类型	描述
`正文（body）`	`ConsoleNotification` 模式

表 5.31. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleNotification` 模式
201 - Created	`ConsoleNotification` 模式
401 - Unauthorized	空

第 6 章 ConsolePlugin [console.openshift.io/v1]

描述

consolePlugin 是一个扩展，可通过从集群中运行的另一个服务动态加载代码来自定义 OpenShift Web 控制台。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。

类型

object

必填

metadata
spec

6.1. 规格

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： 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`	`对象`	ConsolePluginSpec 是所需的插件配置。

6.1.1. .spec

描述

ConsolePluginSpec 是所需的插件配置。

类型

object

必填

后端
displayName

属性	类型	描述
`后端`	`object`	backend 包含提供控制台插件的后端配置。
`displayName`	`字符串`	displayName 是插件的显示名称。dispalyName 应该介于 1 到 128 个字符之间。
`i18n`	`object`	i18n 是插件本地化资源的配置。
`proxy`	`数组`	proxy 是代理列表，用于描述插件需要连接到的各种服务类型。
`proxy[]`	`object`	ConsolePluginProxy 包含有关控制台后端将代理插件请求的各种服务类型的信息。

6.1.2. .spec.backend

描述

backend 包含提供控制台插件的后端配置。

类型

object

必填

type

属性	类型	描述
`service`	`对象`	服务是一个 Kubernetes 服务，它使用带有 HTTP 服务器的部署来公开插件。服务必须使用 HTTPS 和服务服务证书。控制台后端将使用服务 CA 捆绑包代理来自服务的插件资产。
`type`	`string`	type 是服务器控制台插件的后端类型。目前只支持 "Service"。--

6.1.3. .spec.backend.service

描述

服务是一个 Kubernetes 服务，它使用带有 HTTP 服务器的部署来公开插件。服务必须使用 HTTPS 和服务服务证书。控制台后端将使用服务 CA 捆绑包代理来自服务的插件资产。

类型

object

必填

name
namespace
port

属性	类型	描述
`basePath`	`字符串`	basePath 是插件资产的路径。主要资产是名为 `plugin-manifest.json` 的清单文件，它是一个 JSON 文档，其中包含有关插件和扩展的元数据。
`name`	`string`	为插件资产提供服务的 Service 名称。
`namespace`	`string`	为插件资产提供服务的命名空间。
`port`	`整数`	为插件侦听的服务的端口。

6.1.4. .spec.i18n

描述

i18n 是插件本地化资源的配置。

类型

object

必填

loadType

属性	类型	描述
`loadType`	`string`	loadType 表示插件的本地化资源应如何加载。有效值为 Preload、Lazy 和空字符串。当设置为 Preload 时，加载插件时会获取所有本地化资源。当设置为 Lazy 时，本地化资源会因为控制台需要时被加载。当省略或设置为空字符串时，行为等同于 Lazy 类型。

6.1.5. .spec.proxy

描述: proxy 是代理列表，用于描述插件需要连接到的各种服务类型。
类型: 数组

6.1.6. .spec.proxy[]

描述

ConsolePluginProxy 包含有关控制台后端将代理插件请求的各种服务类型的信息。

类型

object

必填

alias
端点

属性	类型	描述
`alias`	`string`	alias 是用于标识插件代理的代理名称。每个插件应具有唯一的别名名称。控制台后端会公开以下代理端点： /api/proxy/plugin/<plugin-name>/<proxy-alias>/<request-path>?<optional-query-parameters> Request example path: /api/proxy/plugin/acm/search/pods?namespace=openshift-apiserver
`授权`	`string`	授权提供有关代理请求应包含授权类型的信息
`caCertificate`	`string`	caCertificate 提供证书颁发机构证书内容，以防代理服务使用自定义服务 CA。默认情况下使用 service-ca 操作器提供的服务 CA 捆绑包。
`端点`	`object`	端点提供有关请求代理的端点的信息。

6.1.7. .spec.proxy[].endpoint

描述

端点提供有关请求代理的端点的信息。

类型

object

必填

type

属性	类型	描述
`service`	`object`	Service 是一个插件将连接到的集群内服务。服务必须使用 HTTPS。控制台后端公开端点，以便代理插件和服务之间的通信。注意：现在需要 service 字段，因为目前只支持 "Service" 类型。
`type`	`string`	type 是控制台插件的代理的类型。目前只支持 "Service"。--

6.1.8. .spec.proxy[].endpoint.service

描述

Service 是一个插件将连接到的集群内服务。服务必须使用 HTTPS。控制台后端公开端点，以便代理插件和服务之间的通信。注意：现在需要 service 字段，因为目前只支持 "Service" 类型。

类型

object

必填

name
namespace
port

属性	类型	描述
`name`	`string`	插件需要连接的服务名称。
`namespace`	`string`	插件需要连接的 Service 的命名空间
`port`	`整数`	插件需要连接的服务的端口。

6.2. API 端点

可用的 API 端点如下：

/apis/console.openshift.io/v1/consoleplugins
- DELETE ：删除 ConsolePlugin 集合
- GET: 列出 kind ConsolePlugin 的对象
- POST ：创建 ConsolePlugin
/apis/console.openshift.io/v1/consoleplugins/{name}
- DELETE ：删除 ConsolePlugin
- GET ：读取指定的 ConsolePlugin
- PATCH: 部分更新指定的 ConsolePlugin
- PUT ：替换指定的 ConsolePlugin

6.2.1. /apis/console.openshift.io/v1/consoleplugins

表 6.1. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

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

表 6.2. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`sendInitialEvents`	`布尔值`	`sendInitialEvents=true` 可以和 `watch=true` 一起设置。在这种情况下，观察流将以复合事件开头，以生成集合中对象的当前状态。发送完所有这些事件后，将发送合成"Bookmark"事件。书签将报告与对象集合对应的 ResourceVersion (RV)，并使用 `"k8s.io/initial-events-end": "true"` 注解进行标记。之后，监视流将照常进行，从而向监视的对象发送与更改对应的监视事件（按 RV 排序）。当设置 `sendInitialEvents` 选项时，我们还需要设置 `resourceVersionMatch` 选项。监控请求的语义如下： - `resourceVersionMatch` = NotOlderThan 解释为"数据至少为提供的 `resourceVersion'"，当状态同步到 'resourceVersion 时，如果状态同步到 ListOptions 提供的 'resourceVersion 时，会发送书签事件`。如果未设置 `resourceVersion`，则这被解释为"consistent read"，当请求开始处理时，将发送书签事件。- `resourceVersionMatch` 设置为任何其他值或未设置 Invalid 错误。如果 `resourceVersion=""` 或 `resourceVersion="0"` （出于向后兼容原因）和 false，则默认为 true。
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

表 6.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

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

表 6.4. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`sendInitialEvents`	`布尔值`	`sendInitialEvents=true` 可以和 `watch=true` 一起设置。在这种情况下，观察流将以复合事件开头，以生成集合中对象的当前状态。发送完所有这些事件后，将发送合成"Bookmark"事件。书签将报告与对象集合对应的 ResourceVersion (RV)，并使用 `"k8s.io/initial-events-end": "true"` 注解进行标记。之后，监视流将照常进行，从而向监视的对象发送与更改对应的监视事件（按 RV 排序）。当设置 `sendInitialEvents` 选项时，我们还需要设置 `resourceVersionMatch` 选项。监控请求的语义如下： - `resourceVersionMatch` = NotOlderThan 解释为"数据至少为提供的 `resourceVersion'"，当状态同步到 'resourceVersion 时，如果状态同步到 ListOptions 提供的 'resourceVersion 时，会发送书签事件`。如果未设置 `resourceVersion`，则这被解释为"consistent read"，当请求开始处理时，将发送书签事件。- `resourceVersionMatch` 设置为任何其他值或未设置 Invalid 错误。如果 `resourceVersion=""` 或 `resourceVersion="0"` （出于向后兼容原因）和 false，则默认为 true。
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

表 6.5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsolePluginList` schema
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 ConsolePlugin

表 6.6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 6.7. 主体参数
参数	类型	描述
`正文（body）`	`consolePlugin` 模式

表 6.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`consolePlugin` 模式
201 - Created	`consolePlugin` 模式
202 - Accepted	`consolePlugin` 模式
401 - Unauthorized	空

6.2.2. /apis/console.openshift.io/v1/consoleplugins/{name}

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

表 6.10. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除 ConsolePlugin

表 6.11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`orphanDependents`	`布尔值`	弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。
`propagationPolicy`	`字符串`	是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。

表 6.12. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions` 模式

表 6.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

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

表 6.14. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

表 6.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`consolePlugin` 模式
401 - Unauthorized	空

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

表 6.16. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求(application/apply-patch)需要此字段，但对非应用补丁类型(JsonPatch、MergePatch、MergePatch)是可选的。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。
`force`	`布尔值`	强制要"强制"应用请求。这意味着用户将重新分配由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。

表 6.17. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

表 6.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`consolePlugin` 模式
401 - Unauthorized	空

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

表 6.19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 6.20. 主体参数
参数	类型	描述
`正文（body）`	`consolePlugin` 模式

表 6.21. HTTP 响应
HTTP 代码	响应正文
200 - OK	`consolePlugin` 模式
201 - Created	`consolePlugin` 模式
401 - Unauthorized	空

第 7 章 ConsoleQuickStart [console.openshift.io/v1]

描述

ConsoleQuickStart 是通过 OpenShift Web 控制台中的各种工作流调整用户的扩展。兼容性级别 2：在主发行版本中至少为 9 个月或 3 个次版本（以更长的时间为准）。

类型

object

必填

spec

7.1. 规格

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： 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`	`对象`	ConsoleQuickStartSpec 是所需的快速启动配置。

7.1.1. .spec

描述

ConsoleQuickStartSpec 是所需的快速启动配置。

类型

object

必填

description
displayName
durationMinutes
简介
tasks

属性	类型	描述
`accessReviewResources`	`array`	accessReviewResources 包含了一个资源列表，用户会对其进行检查，以便用户完成快速入门。如果任何访问检查失败，快速入门会被隐藏。
`accessReviewResources[]`	`对象`	ResourceAttributes 包含对 Authorizer 接口的资源请求的授权属性
`conclusion`	`字符串`	总结总结快速入门并推荐后续步骤。（包括标记）
`description`	`字符串`	description 是快速入门的描述。（包括标记）
`displayName`	`字符串`	displayName 是 Quick Start 的显示名称。
`durationMinutes`	`整数`	durationMinutes 描述了完成快速入门所需的时间大约需要多少分钟。
`icon`	`字符串`	图标是一个 base64 编码镜像，它将在 Quick Start 显示名称旁边显示。该图标应该是用于轻松扩展的向量镜像。图标的大小应为 40x40。
`简介`	`字符串`	简介描述了快速入门的目的。（包括标记）
`nextQuickStart`	`数组（字符串）`	nextQuickStart 是以下快速入门列表，建议用户尝试。
`先决条件`	`数组（字符串）`	先决条件包含执行快速入门前需要满足的所有先决条件。（包括标记）
`tags`	`数组（字符串）`	tags 是描述快速入门的字符串列表。
`tasks`	`array`	Task (Task)是用户完成快速入门必须执行的步骤列表。
`tasks[]`	`对象`	ConsoleQuickStartTask 是快速入门中的一个步骤。

7.1.2. .spec.accessReviewResources

描述: accessReviewResources 包含了一个资源列表，用户会对其进行检查，以便用户完成快速入门。如果任何访问检查失败，快速入门会被隐藏。
类型: array

7.1.3. .spec.accessReviewResources[]

描述: ResourceAttributes 包含对 Authorizer 接口的资源请求的授权属性
类型: object

属性	类型	描述
`group`	`字符串`	Group 是 Resource 的 API 组。"*"代表所有。
`name`	`字符串`	Name 是为"get"请求的资源的名称，或删除"delete"。"" （空）表示全部。
`namespace`	`字符串`	namespace 是所请求操作的命名空间。目前，对于集群范围的资源 "" (empty)，没有命名空间和所有命名空间"" （空）之间的差别，对于集群范围的资源 "" （空）代表"all"表示来自 SubjectAccessReview 或 SelfSubjectAccessReview 的命名空间范围资源
`resource`	`字符串`	资源是现有资源类型之一。"*"表示全部。
`subresource`	`字符串`	子资源是现有资源类型之一。""表示 none。
`verb`	`字符串`	verb 是一个 kubernetes 资源 API 动词，如： get, list, watch, create, update, delete, proxy. "*" 表示所有。
`version`	`字符串`	version 是资源的 API 版本。"*"表示所有。

7.1.4. .spec.tasks

描述: Task (Task)是用户完成快速入门必须执行的步骤列表。
类型: array

7.1.5. .spec.tasks[]

描述

ConsoleQuickStartTask 是快速入门中的一个步骤。

类型

object

必填

description
title

属性	类型	描述
`description`	`字符串`	Description 描述了完成任务所需的步骤。（包括标记）
`review`	`对象`	检查包含验证任务是否完成的说明。用户将使用单选按钮选择"是"或"否"，这指示步骤是否已成功完成。
`summary`	`对象`	Summary 包含有关传递步骤的信息。
`title`	`字符串`	title 描述了任务，显示为步骤标题。

7.1.6. .spec.tasks[].review

描述

检查包含验证任务是否完成的说明。用户将使用单选按钮选择"是"或"否"，这指示步骤是否已成功完成。

类型

object

必填

failedTaskHelp
说明

属性	类型	描述
`failedTaskHelp`	`字符串`	failedTaskHelp 包含失败任务检查的建议，并在任务末尾显示。（包括标记）
`说明`	`字符串`	指令包含用户在完成任务后需要采取的步骤（包括标记）

7.1.7. .spec.tasks[].summary

描述

Summary 包含有关传递步骤的信息。

类型

object

必填

失败
success

属性	类型	描述
`失败`	`字符串`	failed 简要描述了未成功通过的任务。（包括标记）
`success`	`字符串`	成功描述了 succesfully passed 的任务。

7.2. API 端点

可用的 API 端点如下：

/apis/console.openshift.io/v1/consolequickstarts
- DELETE: 删除 ConsoleQuickStart 集合
- GET: 列出类型为 ConsoleQuickStart 的对象
- POST ：创建 ConsoleQuickStart
/apis/console.openshift.io/v1/consolequickstarts/{name}
- DELETE: delete a ConsoleQuickStart
- GET ：读取指定的 ConsoleQuickStart
- PATCH: 部分更新指定的 ConsoleQuickStart
- PUT ：替换指定的 ConsoleQuickStart

7.2.1. /apis/console.openshift.io/v1/consolequickstarts

表 7.1. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

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

表 7.2. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`sendInitialEvents`	`布尔值`	`sendInitialEvents=true` 可以和 `watch=true` 一起设置。在这种情况下，观察流将以复合事件开头，以生成集合中对象的当前状态。发送完所有这些事件后，将发送合成"Bookmark"事件。书签将报告与对象集合对应的 ResourceVersion (RV)，并使用 `"k8s.io/initial-events-end": "true"` 注解进行标记。之后，监视流将照常进行，从而向监视的对象发送与更改对应的监视事件（按 RV 排序）。当设置 `sendInitialEvents` 选项时，我们还需要设置 `resourceVersionMatch` 选项。监控请求的语义如下： - `resourceVersionMatch` = NotOlderThan 解释为"数据至少为提供的 `resourceVersion'"，当状态同步到 'resourceVersion 时，如果状态同步到 ListOptions 提供的 'resourceVersion 时，会发送书签事件`。如果未设置 `resourceVersion`，则这被解释为"consistent read"，当请求开始处理时，将发送书签事件。- `resourceVersionMatch` 设置为任何其他值或未设置 Invalid 错误。如果 `resourceVersion=""` 或 `resourceVersion="0"` （出于向后兼容原因）和 false，则默认为 true。
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

表 7.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

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

表 7.4. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`sendInitialEvents`	`布尔值`	`sendInitialEvents=true` 可以和 `watch=true` 一起设置。在这种情况下，观察流将以复合事件开头，以生成集合中对象的当前状态。发送完所有这些事件后，将发送合成"Bookmark"事件。书签将报告与对象集合对应的 ResourceVersion (RV)，并使用 `"k8s.io/initial-events-end": "true"` 注解进行标记。之后，监视流将照常进行，从而向监视的对象发送与更改对应的监视事件（按 RV 排序）。当设置 `sendInitialEvents` 选项时，我们还需要设置 `resourceVersionMatch` 选项。监控请求的语义如下： - `resourceVersionMatch` = NotOlderThan 解释为"数据至少为提供的 `resourceVersion'"，当状态同步到 'resourceVersion 时，如果状态同步到 ListOptions 提供的 'resourceVersion 时，会发送书签事件`。如果未设置 `resourceVersion`，则这被解释为"consistent read"，当请求开始处理时，将发送书签事件。- `resourceVersionMatch` 设置为任何其他值或未设置 Invalid 错误。如果 `resourceVersion=""` 或 `resourceVersion="0"` （出于向后兼容原因）和 false，则默认为 true。
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

表 7.5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleQuickStartList` schema
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 ConsoleQuickStart

表 7.6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 7.7. 主体参数
参数	类型	描述
`正文（body）`	`ConsoleQuickStart` schema

表 7.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleQuickStart` schema
201 - Created	`ConsoleQuickStart` schema
202 - Accepted	`ConsoleQuickStart` schema
401 - Unauthorized	空

7.2.2. /apis/console.openshift.io/v1/consolequickstarts/{name}

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

表 7.10. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: delete a ConsoleQuickStart

表 7.11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`orphanDependents`	`布尔值`	弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。
`propagationPolicy`	`字符串`	是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。

表 7.12. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions` 模式

表 7.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 阅读指定的 ConsoleQuickStart

表 7.14. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

表 7.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleQuickStart` schema
401 - Unauthorized	空

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

表 7.16. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求(application/apply-patch)需要此字段，但对非应用补丁类型(JsonPatch、MergePatch、MergePatch)是可选的。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。
`force`	`布尔值`	强制要"强制"应用请求。这意味着用户将重新分配由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。

表 7.17. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

表 7.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleQuickStart` schema
401 - Unauthorized	空

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

表 7.19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 7.20. 主体参数
参数	类型	描述
`正文（body）`	`ConsoleQuickStart` schema

表 7.21. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleQuickStart` schema
201 - Created	`ConsoleQuickStart` schema
401 - Unauthorized	空

第 8 章 ConsoleYAMLSample [console.openshift.io/v1]

描述

ConsoleYAMLSample 是自定义 OpenShift Web 控制台 YAML 样本的扩展。兼容性级别 2：在主发行版本中至少为 9 个月或 3 个次版本（以更长的时间为准）。

类型

object

必填

metadata
spec

8.1. 规格

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： 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`	`对象`	ConsoleYAMLSampleSpec 是所需的 YAML 示例配置。在 web 控制台中创建资源时，示例会在示例栏中显示。

8.1.1. .spec

描述

ConsoleYAMLSampleSpec 是所需的 YAML 示例配置。在 web 控制台中创建资源时，示例会在示例栏中显示。

类型

object

必填

description
targetResource
title
yaml

属性	类型	描述
`description`	`字符串`	YAML 示例的描述。
`snippet`	`布尔值`	代码片段表示 YAML 示例不是完整的 YAML 资源定义，而是可插入到用户光标处的现有 YAML 文档中的片段。
`targetResource`	`对象`	targetResource 包含 apiVersion 和 kind of the resource YAML 示例代表。
`title`	`字符串`	YAML 样本的标题。
`yaml`	`字符串`	yaml 是要显示的 YAML 示例。

8.1.2. .spec.targetResource

描述: targetResource 包含 apiVersion 和 kind of the resource YAML 示例代表。
类型: object

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

8.2. API 端点

可用的 API 端点如下：

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

8.2.1. /apis/console.openshift.io/v1/consoleyamlsamples

表 8.1. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

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

表 8.2. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`sendInitialEvents`	`布尔值`	`sendInitialEvents=true` 可以和 `watch=true` 一起设置。在这种情况下，观察流将以复合事件开头，以生成集合中对象的当前状态。发送完所有这些事件后，将发送合成"Bookmark"事件。书签将报告与对象集合对应的 ResourceVersion (RV)，并使用 `"k8s.io/initial-events-end": "true"` 注解进行标记。之后，监视流将照常进行，从而向监视的对象发送与更改对应的监视事件（按 RV 排序）。当设置 `sendInitialEvents` 选项时，我们还需要设置 `resourceVersionMatch` 选项。监控请求的语义如下： - `resourceVersionMatch` = NotOlderThan 解释为"数据至少为提供的 `resourceVersion'"，当状态同步到 'resourceVersion 时，如果状态同步到 ListOptions 提供的 'resourceVersion 时，会发送书签事件`。如果未设置 `resourceVersion`，则这被解释为"consistent read"，当请求开始处理时，将发送书签事件。- `resourceVersionMatch` 设置为任何其他值或未设置 Invalid 错误。如果 `resourceVersion=""` 或 `resourceVersion="0"` （出于向后兼容原因）和 false，则默认为 true。
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

表 8.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出 kind ConsoleYAMLSample 的对象

表 8.4. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`sendInitialEvents`	`布尔值`	`sendInitialEvents=true` 可以和 `watch=true` 一起设置。在这种情况下，观察流将以复合事件开头，以生成集合中对象的当前状态。发送完所有这些事件后，将发送合成"Bookmark"事件。书签将报告与对象集合对应的 ResourceVersion (RV)，并使用 `"k8s.io/initial-events-end": "true"` 注解进行标记。之后，监视流将照常进行，从而向监视的对象发送与更改对应的监视事件（按 RV 排序）。当设置 `sendInitialEvents` 选项时，我们还需要设置 `resourceVersionMatch` 选项。监控请求的语义如下： - `resourceVersionMatch` = NotOlderThan 解释为"数据至少为提供的 `resourceVersion'"，当状态同步到 'resourceVersion 时，如果状态同步到 ListOptions 提供的 'resourceVersion 时，会发送书签事件`。如果未设置 `resourceVersion`，则这被解释为"consistent read"，当请求开始处理时，将发送书签事件。- `resourceVersionMatch` 设置为任何其他值或未设置 Invalid 错误。如果 `resourceVersion=""` 或 `resourceVersion="0"` （出于向后兼容原因）和 false，则默认为 true。
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

表 8.5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleYAMLSampleList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 ConsoleYAMLSample

表 8.6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 8.7. 主体参数
参数	类型	描述
`正文（body）`	`ConsoleYAMLSample` 模式

表 8.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleYAMLSample` 模式
201 - Created	`ConsoleYAMLSample` 模式
202 - Accepted	`ConsoleYAMLSample` 模式
401 - Unauthorized	空

8.2.2. /apis/console.openshift.io/v1/consoleyamlsamples/{name}

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

表 8.10. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除 ConsoleYAMLSample

表 8.11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`orphanDependents`	`布尔值`	弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。
`propagationPolicy`	`字符串`	是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。

表 8.12. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions` 模式

表 8.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 阅读指定的 ConsoleYAMLSample

表 8.14. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

表 8.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleYAMLSample` 模式
401 - Unauthorized	空

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

表 8.16. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求(application/apply-patch)需要此字段，但对非应用补丁类型(JsonPatch、MergePatch、MergePatch)是可选的。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。
`force`	`布尔值`	强制要"强制"应用请求。这意味着用户将重新分配由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。

表 8.17. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

表 8.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleYAMLSample` 模式
401 - Unauthorized	空

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

表 8.19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 8.20. 主体参数
参数	类型	描述
`正文（body）`	`ConsoleYAMLSample` 模式

表 8.21. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleYAMLSample` 模式
201 - Created	`ConsoleYAMLSample` 模式
401 - Unauthorized	空

控制台 API 的参考指南

第 1 章 控制台 API

1.1. ConsoleCLIDownload [console.openshift.io/v1]

1.2. ConsoleExternalLogLink [console.openshift.io/v1]

1.3. ConsoleLink [console.openshift.io/v1]

1.4. ConsoleNotification [console.openshift.io/v1]

1.5. ConsolePlugin [console.openshift.io/v1]

1.6. ConsoleQuickStart [console.openshift.io/v1]

1.7. ConsoleYAMLSample [console.openshift.io/v1]

第 2 章 ConsoleCLIDownload [console.openshift.io/v1]

2.1. 规格

2.1.1. .spec

2.1.2. .spec.links

2.1.3. .spec.links[]

2.2. API 端点

2.2.1. /apis/console.openshift.io/v1/consoleclidownloads

2.2.2. /apis/console.openshift.io/v1/consoleclidownloads/{name}

2.2.3. /apis/console.openshift.io/v1/consoleclidownloads/{name}/status

第 3 章 ConsoleExternalLogLink [console.openshift.io/v1]

3.1. 规格

3.1.1. .spec

3.2. API 端点

3.2.1. /apis/console.openshift.io/v1/consoleexternalloglinks

3.2.2. /apis/console.openshift.io/v1/consoleexternalloglinks/{name}

3.2.3. /apis/console.openshift.io/v1/consoleexternalloglinks/{name}/status

第 4 章 ConsoleLink [console.openshift.io/v1]

4.1. 规格

4.1.1. .spec

4.1.2. .spec.applicationMenu

4.1.3. .spec.namespaceDashboard

4.1.4. .spec.namespaceDashboard.namespaceSelector

4.1.5. .spec.namespaceDashboard.namespaceSelector.matchExpressions

4.1.6. .spec.namespaceDashboard.namespaceSelector.matchExpressions[]

4.2. API 端点

4.2.1. /apis/console.openshift.io/v1/consolelinks

4.2.2. /apis/console.openshift.io/v1/consolelinks/{name}

4.2.3. /apis/console.openshift.io/v1/consolelinks/{name}/status

第 5 章 ConsoleNotification [console.openshift.io/v1]

5.1. 规格

5.1.1. .spec

5.1.2. .spec.link

5.2. API 端点

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

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

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

第 6 章 ConsolePlugin [console.openshift.io/v1]

6.1. 规格

6.1.1. .spec

6.1.2. .spec.backend

6.1.3. .spec.backend.service

6.1.4. .spec.i18n

6.1.5. .spec.proxy

6.1.6. .spec.proxy[]

6.1.7. .spec.proxy[].endpoint

6.1.8. .spec.proxy[].endpoint.service

6.2. API 端点

6.2.1. /apis/console.openshift.io/v1/consoleplugins

6.2.2. /apis/console.openshift.io/v1/consoleplugins/{name}

第 7 章 ConsoleQuickStart [console.openshift.io/v1]

7.1. 规格

7.1.1. .spec

7.1.2. .spec.accessReviewResources

7.1.3. .spec.accessReviewResources[]

7.1.4. .spec.tasks

7.1.5. .spec.tasks[]

7.1.6. .spec.tasks[].review

7.1.7. .spec.tasks[].summary

7.2. API 端点

7.2.1. /apis/console.openshift.io/v1/consolequickstarts

7.2.2. /apis/console.openshift.io/v1/consolequickstarts/{name}

第 8 章 ConsoleYAMLSample [console.openshift.io/v1]

8.1. 规格

8.1.1. .spec

8.1.2. .spec.targetResource

8.2. API 端点

8.2.1. /apis/console.openshift.io/v1/consoleyamlsamples

8.2.2. /apis/console.openshift.io/v1/consoleyamlsamples/{name}

Legal Notice

学习

第 1 章控制台 API