OpenShift 文档正在迁移，很快将只能在 docs.redhat.com（所有 Red Hat 产品文档的所在地）访问。立即体验 新的文档体验。
  1. 文档
    2. history bug_report picture_as_pdf
×

控制台 [config.openshift.io/v1]

描述

Console保存集群范围的Web控制台配置，包括注销URL，并报告控制台的公共URL。规范名称为cluster。兼容性级别1：在主要版本中至少稳定12个月或3个次要版本（以较长者为准）。

类型

对象

必需

  • spec

规格

属性 类型 描述

apiVersion

字符串

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

kind

字符串

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

metadata

ObjectMeta

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

spec

对象

spec保存用户可设置的配置值

status

对象

status保存从集群观察到的值。它们可能不会被覆盖。

.spec

描述

spec保存用户可设置的配置值

类型

对象

属性 类型 描述

authentication

对象

ConsoleAuthentication定义了控制台身份验证的可选配置列表。

.spec.authentication

描述

ConsoleAuthentication定义了控制台身份验证的可选配置列表。

类型

对象

属性 类型 描述

logoutRedirect

字符串

一个可选的绝对URL，用于在注销控制台后将Web浏览器重定向到该URL。如果未指定，它将重定向到默认登录页面。当使用支持单点登录（SSO）的身份提供商时，这是必需的，例如：- OpenID（Keycloak，Azure）- RequestHeader（GSSAPI，SSPI，SAML）- OAuth（GitHub，GitLab，Google）注销控制台将销毁用户的令牌。logoutRedirect为用户提供了通过身份提供商执行单点注销（SLO）以销毁其单点登录会话的选项。

.status

描述

status保存从集群观察到的值。它们可能不会被覆盖。

类型

对象

属性 类型 描述

consoleURL

字符串

控制台的URL。这将从为控制台创建的路由的主机派生。

API端点

以下API端点可用

  • /apis/config.openshift.io/v1/consoles

    • DELETE：删除Console集合

    • GET：列出Console类型的对象

    • POST：创建一个Console

  • /apis/config.openshift.io/v1/consoles/{name}

    • DELETE：删除一个Console

    • GET：读取指定的Console

    • PATCH：部分更新指定的Console

    • PUT：替换指定的Console

  • /apis/config.openshift.io/v1/consoles/{name}/status

    • GET：读取指定的Console的状态

    • PATCH：部分更新指定的Console的状态

    • PUT：替换指定的Console的状态

/apis/config.openshift.io/v1/consoles

HTTP方法

DELETE

描述

删除Console集合

表1. HTTP响应
HTTP代码 响应体

200 - OK

Status 模式

401 - 未授权

空
HTTP方法

GET

描述

列出 Console 对象

表 2. HTTP 响应
HTTP代码 响应体

200 - OK

ConsoleList 模式

401 - 未授权

空
HTTP方法

POST

描述

创建 Console

表 3. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象静默丢弃的未知字段，并将忽略解码器遇到的所有重复字段中的最后一个字段之前的默认行为。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认设置 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 4. 请求体参数
参数 类型 描述

body

Console 模式
表 5. HTTP 响应
HTTP代码 响应体

200 - OK

Console 模式

201 - 已创建

Console 模式

202 - 已接受

Console 模式

401 - 未授权

空

/apis/config.openshift.io/v1/consoles/{name}

表 6. 全局路径参数
参数 类型 描述

name

字符串

Console 的名称
HTTP方法

DELETE

描述

删除 Console

表 7. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
表 8. HTTP 响应
HTTP代码 响应体

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

空
HTTP方法

GET

描述

读取指定的 Console

表 9. HTTP 响应
HTTP代码 响应体

200 - OK

Console 模式

401 - 未授权

空
HTTP方法

PATCH

描述

部分更新指定的 Console

表 10. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象静默丢弃的未知字段，并将忽略解码器遇到的所有重复字段中的最后一个字段之前的默认行为。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认设置 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 11. HTTP 响应
HTTP代码 响应体

200 - OK

Console 模式

401 - 未授权

空
HTTP方法

PUT

描述

替换指定的 Console

表 12. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象静默丢弃的未知字段，并将忽略解码器遇到的所有重复字段中的最后一个字段之前的默认行为。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认设置 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 13. 请求体参数
参数 类型 描述

body

Console 模式
表 14. HTTP 响应
HTTP代码 响应体

200 - OK

Console 模式

201 - 已创建

Console 模式

401 - 未授权

空

/apis/config.openshift.io/v1/consoles/{name}/status

表 15. 全局路径参数
参数 类型 描述

name

字符串

Console 的名称
HTTP方法

GET

描述

读取指定 Console 的状态

表 16. HTTP 响应
HTTP代码 响应体

200 - OK

Console 模式

401 - 未授权

空
HTTP方法

PATCH

描述

部分更新指定 Console 的状态

表 17. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象静默丢弃的未知字段，并将忽略解码器遇到的所有重复字段中的最后一个字段之前的默认行为。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认设置 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 18. HTTP 响应
HTTP代码 响应体

200 - OK

Console 模式

401 - 未授权

空
HTTP方法

PUT

描述

替换指定 Console 的状态

表 19. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象静默丢弃的未知字段，并将忽略解码器遇到的所有重复字段中的最后一个字段之前的默认行为。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认设置 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 20. 请求体参数
参数 类型 描述

body

Console 模式
表 21. HTTP 响应
HTTP代码 响应体

200 - OK

Console 模式

201 - 已创建

Console 模式

401 - 未授权

空