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

控制台链接 [console.openshift.io/v1]

规范

属性 类型 描述

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

对象

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

.spec

描述

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

类型

对象

必需

  • href

  • 位置

  • 文本

属性 类型 描述

applicationMenu

对象

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

href

字符串

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

位置

字符串

location 确定将链接附加到控制台中的哪个位置（ApplicationMenu、HelpMenu、UserMenu、NamespaceDashboard）。

namespaceDashboard

对象

namespaceDashboard 包含有关仪表盘链接应显示的命名空间的信息，并且仅在位置设置为 NamespaceDashboard 时适用。如果未指定，则链接将显示在所有命名空间中。

文本

字符串

text 是链接的显示文本

.spec.applicationMenu

描述

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

类型

对象

必需

  • 部分

属性 类型 描述

imageURL

字符串

imageUrl 是应用程序菜单中链接前面使用的图标的 URL。URL 必须是 HTTPS URL 或数据 URI。图像应为正方形，并将以 24x24 像素显示。

部分

字符串

section 是应用程序菜单中链接应显示的部分。这可以是任何文本，这些文本将作为应用程序菜单下拉列表中的小标题显示。如果文本与现有部分的文本不匹配，则将创建一个新部分。

.spec.namespaceDashboard

描述

namespaceDashboard 包含有关仪表盘链接应显示的命名空间的信息，并且仅在位置设置为 NamespaceDashboard 时适用。如果未指定，则链接将显示在所有命名空间中。

类型

对象

属性 类型 描述

namespaceSelector

对象

namespaceSelector 用于通过标签选择应包含仪表盘链接的命名空间。如果命名空间标签匹配，则将为命名空间显示仪表盘链接。

namespaces

数组（字符串）

namespaces 是应显示仪表盘链接的命名空间名称数组。

.spec.namespaceDashboard.namespaceSelector

描述

namespaceSelector 用于通过标签选择应包含仪表盘链接的命名空间。如果命名空间标签匹配，则将为命名空间显示仪表盘链接。

类型

对象

属性 类型 描述

matchExpressions

数组

matchExpressions 是标签选择器要求的列表。这些要求是 ANDed 的。

matchExpressions[]

对象

标签选择器要求是一个选择器，它包含值、键和一个关联键和值的运算符。

matchLabels

对象（字符串）

matchLabels 是 {key,value} 对的映射。matchLabels 映射中的单个 {key,value} 等效于 matchExpressions 的一个元素，其 key 字段为“key”，运算符为“In”，而 values 数组仅包含“value”。这些要求是 ANDed 的。

.spec.namespaceDashboard.namespaceSelector.matchExpressions

描述

matchExpressions 是标签选择器要求的列表。这些要求是 ANDed 的。

类型

数组

.spec.namespaceDashboard.namespaceSelector.matchExpressions[]

描述

标签选择器要求是一个选择器，它包含值、键和一个关联键和值的运算符。

类型

对象

必需

  • key

  • 运算符

属性 类型 描述

key

字符串

key 是选择器应用到的标签键。

运算符

字符串

operator 表示键与一组值的关系。有效的运算符为 In、NotIn、Exists 和 DoesNotExist。

values

数组（字符串）

values 是字符串值的数组。如果运算符是 In 或 NotIn，则 values 数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则 values 数组必须为空。此数组在策略性合并修补程序期间将被替换。

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 的状态

HTTP 方法

DELETE

描述

删除 ConsoleLink 集合

表 1. HTTP 响应
HTTP 代码 响应正文

200 - OK

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

列出 ConsoleLink 类型的对象

表 2. HTTP 响应
HTTP 代码 响应正文

200 - OK

ConsoleLinkList 模式

401 - 未授权

空
HTTP 方法

POST

描述

创建一个 ConsoleLink

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

dryRun

字符串

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

fieldValidation

字符串

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

body

ConsoleLink 模式
表 5. HTTP 响应
HTTP 代码 响应正文

200 - OK

ConsoleLink 模式

201 - 已创建

ConsoleLink 模式

202 - 已接受

ConsoleLink 模式

401 - 未授权

空

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

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

name

字符串

ConsoleLink 的名称
HTTP 方法

DELETE

描述

删除 ConsoleLink

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

dryRun

字符串

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

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

读取指定的 ConsoleLink

表 9. HTTP 响应
HTTP 代码 响应正文

200 - OK

ConsoleLink 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 ConsoleLink

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

ConsoleLink 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 ConsoleLink

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

dryRun

字符串

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

fieldValidation

字符串

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

body

ConsoleLink 模式
表 14. HTTP 响应
HTTP 代码 响应正文

200 - OK

ConsoleLink 模式

201 - 已创建

ConsoleLink 模式

401 - 未授权

空

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

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

name

字符串

ConsoleLink 的名称
HTTP 方法

GET

描述

读取指定的 ConsoleLink 的状态

表 16. HTTP 响应
HTTP 代码 响应正文

200 - OK

ConsoleLink 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 ConsoleLink 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

ConsoleLink 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 ConsoleLink 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

body

ConsoleLink 模式
表 21. HTTP 响应
HTTP 代码 响应正文

200 - OK

ConsoleLink 模式

201 - 已创建

ConsoleLink 模式

401 - 未授权

空