×
描述

ConsoleCLIDownload 是一个用于配置 OpenShift Web 控制台命令行界面 (CLI) 下载的扩展。兼容性级别 2:在主要版本中至少稳定 9 个月或 3 个次要版本(以较长者为准)。

类型

对象

必需
  • spec

规范

属性 类型 描述

apiVersion

字符串

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

kind

字符串

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

metadata

ObjectMeta

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

spec

对象

ConsoleCLIDownloadSpec 是所需的 CLI 下载配置。

.spec

描述

ConsoleCLIDownloadSpec 是所需的 CLI 下载配置。

类型

对象

必需
  • description

  • displayName

  • links

属性 类型 描述

description

字符串

description 是 CLI 下载的描述(可以包含 Markdown)。

displayName

字符串

displayName 是 CLI 下载的显示名称。

links

数组

links 是提供 CLI 下载链接详细信息的对象列表。

links[]

对象

描述

links 是提供 CLI 下载链接详细信息的对象列表。

类型

数组

描述
类型

对象

必需
  • href

属性 类型 描述

href

字符串

href 是链接的绝对安全 URL(必须使用 https)

text

字符串

text 是链接的显示文本

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

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

HTTP 方法

DELETE

描述

删除 ConsoleCLIDownload 集合

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

200 - OK

Status 模式

401 - 未授权

HTTP 方法

GET

描述

列出 ConsoleCLIDownload 类型的对象

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

200 - OK

ConsoleCLIDownloadList 模式

401 - 未授权

HTTP 方法

POST

描述

创建 ConsoleCLIDownload

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

dryRun

字符串

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

fieldValidation

字符串

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

表 4. 请求体参数
参数 类型 描述

body

ConsoleCLIDownload 模式

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

200 - OK

ConsoleCLIDownload 模式

201 - 已创建

ConsoleCLIDownload 模式

202 - 已接受

ConsoleCLIDownload 模式

401 - 未授权

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

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

name

字符串

ConsoleCLIDownload 的名称

HTTP 方法

DELETE

描述

删除 ConsoleCLIDownload

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

dryRun

字符串

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

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

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

HTTP 方法

GET

描述

读取指定的 ConsoleCLIDownload

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

200 - OK

ConsoleCLIDownload 模式

401 - 未授权

HTTP 方法

PATCH

描述

部分更新指定的 ConsoleCLIDownload

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

dryRun

字符串

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

fieldValidation

字符串

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

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

200 - OK

ConsoleCLIDownload 模式

401 - 未授权

HTTP 方法

PUT

描述

替换指定的 ConsoleCLIDownload

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

dryRun

字符串

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

fieldValidation

字符串

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

表 13. 请求体参数
参数 类型 描述

body

ConsoleCLIDownload 模式

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

200 - OK

ConsoleCLIDownload 模式

201 - 已创建

ConsoleCLIDownload 模式

401 - 未授权

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

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

name

字符串

ConsoleCLIDownload 的名称

HTTP 方法

GET

描述

读取指定 ConsoleCLIDownload 的状态

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

200 - OK

ConsoleCLIDownload 模式

401 - 未授权

HTTP 方法

PATCH

描述

部分更新指定 ConsoleCLIDownload 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

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

200 - OK

ConsoleCLIDownload 模式

401 - 未授权

HTTP 方法

PUT

描述

替换指定 ConsoleCLIDownload 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

表 20. 请求体参数
参数 类型 描述

body

ConsoleCLIDownload 模式

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

200 - OK

ConsoleCLIDownload 模式

201 - 已创建

ConsoleCLIDownload 模式

401 - 未授权