主页
产品
Red Hat Quay
3.2
测试 REST
8.7. Console [config.openshift.io/v1]

8.7. Console [config.openshift.io/v1]

描述

控制台包含 web 控制台的集群范围配置，包括注销 URL，并报告控制台的公共 URL。规范名称为 cluster。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。

类型

对象

必填

spec

8.7.1. 规格
复制链接

Expand

属性	类型	描述
`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_v2`	标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`对象`	spec 包含用户配置可设置值
`status`	`对象`	status 包含从集群中观察到的值。它们可能无法覆盖。

8.7.1.1. .spec
复制链接

描述: spec 包含用户配置可设置值
类型: 对象

Expand

属性	类型	描述
`身份验证`	`对象`	ConsoleAuthentication 定义用于控制台身份验证的可选配置列表。

8.7.1.2. .spec.authentication
复制链接

描述: ConsoleAuthentication 定义用于控制台身份验证的可选配置列表。
类型: 对象

Expand

属性	类型	描述
`logoutRedirect`	`字符串`	从控制台注销后，用于将 Web 浏览器重定向到的可选绝对 URL。如果未指定，它将重定向到默认的登录页面。当使用支持单点登录(SSO)的身份供应商时（如 - OpenID (Keycloak、Azure)- RequestHeader (GSSAPI, SSPI, SAML)- OAuth (GitHub, GitLab, Google) Logging out the user's token.logoutRedirect 为用户提供通过身份提供程序执行单注销(SLO)的选项，以销毁其单点登录会话。

8.7.1.3. .status
复制链接

描述: status 包含从集群中观察到的值。它们可能无法覆盖。
类型: 对象

Expand

属性	类型	描述
`consoleURL`	`字符串`	控制台的 URL。这将从为控制台创建的路由的主机派生。

8.7.2. API 端点
复制链接

可用的 API 端点如下：

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

8.7.2.1. /apis/config.openshift.io/v1/consoles
复制链接

Expand

表 8.156. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果 'true'，则输出被用户友善。

HTTP 方法: DELETE
描述: 删除控制台集合

Expand

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

Expand

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

HTTP 方法: GET
描述: 列出控制台的对象

Expand

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

Expand

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

HTTP 方法: POST
描述: 创建控制台

Expand

表 8.161. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand

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

Expand

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

8.7.2.2. /apis/config.openshift.io/v1/consoles/{name}
复制链接

Expand

表 8.164. 全局路径参数
参数	类型	描述
`name`	`字符串`	控制台的名称

Expand

表 8.165. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果 'true'，则输出被用户友善。

HTTP 方法: DELETE
描述: 删除控制台

Expand

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

Expand

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

Expand

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

HTTP 方法: GET
描述: 读取指定的控制台

Expand

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

Expand

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

HTTP 方法: PATCH
描述: 部分更新指定的控制台

Expand

表 8.171. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand

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

Expand

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

HTTP 方法: PUT
描述: 替换指定的控制台

Expand

表 8.174. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand

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

Expand

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

8.7.2.3. /apis/config.openshift.io/v1/consoles/{name}/status
复制链接

Expand

表 8.177. 全局路径参数
参数	类型	描述
`name`	`字符串`	控制台的名称

Expand

表 8.178. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果 'true'，则输出被用户友善。

HTTP 方法: GET
描述: 指定控制台的读取状态

Expand

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

Expand

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

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

Expand

表 8.181. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand

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

Expand

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

HTTP 方法: PUT
描述: 替换指定控制台的状态

Expand

表 8.184. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand

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

Expand

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

返回顶部

8.7. Console [config.openshift.io/v1]

8.7.1. 规格
复制链接

8.7.1.1. .spec
复制链接

8.7.1.2. .spec.authentication
复制链接

8.7.1.3. .status
复制链接

8.7.2. API 端点
复制链接

8.7.2.1. /apis/config.openshift.io/v1/consoles
复制链接

8.7.2.2. /apis/config.openshift.io/v1/consoles/{name}
复制链接

8.7.2.3. /apis/config.openshift.io/v1/consoles/{name}/status
复制链接

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

8.7. Console [config.openshift.io/v1]

8.7.1. 规格复制链接链接已复制到粘贴板!

8.7.1.1. .spec复制链接链接已复制到粘贴板!

8.7.1.2. .spec.authentication复制链接链接已复制到粘贴板!

8.7.1.3. .status复制链接链接已复制到粘贴板!

8.7.2. API 端点复制链接链接已复制到粘贴板!

8.7.2.1. /apis/config.openshift.io/v1/consoles复制链接链接已复制到粘贴板!

8.7.2.2. /apis/config.openshift.io/v1/consoles/{name}复制链接链接已复制到粘贴板!

8.7.2.3. /apis/config.openshift.io/v1/consoles/{name}/status复制链接链接已复制到粘贴板!

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

8.7.1. 规格
复制链接

8.7.1.1. .spec
复制链接

8.7.1.2. .spec.authentication
复制链接

8.7.1.3. .status
复制链接

8.7.2. API 端点
复制链接

8.7.2.1. /apis/config.openshift.io/v1/consoles
复制链接

8.7.2.2. /apis/config.openshift.io/v1/consoles/{name}
复制链接

8.7.2.3. /apis/config.openshift.io/v1/consoles/{name}/status
复制链接