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

ConsoleYAMLSample [console.openshift.io/v1]

描述

ConsoleYAMLSample 是用于自定义 OpenShift Web 控制台 YAML 示例的扩展。兼容性级别 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

元数据

ObjectMeta

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

spec

对象

ConsoleYAMLSampleSpec 是所需的 YAML 示例配置。在 Web 控制台中创建资源时，样本及其描述将显示在样本侧边栏中。

.spec

描述

ConsoleYAMLSampleSpec 是所需的 YAML 示例配置。在 Web 控制台中创建资源时，样本及其描述将显示在样本侧边栏中。

类型

对象

必需

  • 描述

  • targetResource

  • 标题

  • yaml

属性 类型 描述

描述

字符串

YAML 示例的描述。

代码片段

布尔值

代码片段表示 YAML 示例不是完整的 YAML 资源定义，而是在用户光标处可以插入到现有 YAML 文档中的片段。

targetResource

对象

targetResource 包含资源 YAML 示例所代表的 apiVersion 和 kind。

标题

字符串

YAML 示例的标题。

yaml

字符串

yaml 是要显示的 YAML 示例。

.spec.targetResource

描述

targetResource 包含资源 YAML 示例所代表的 apiVersion 和 kind。

类型

对象

属性 类型 描述

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

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

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

HTTP 方法

DELETE

描述

删除 ConsoleYAMLSample 集合

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

200 - OK

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

列出 ConsoleYAMLSample 类型的对象

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

200 - OK

ConsoleYAMLSampleList 模式

401 - 未授权

空
HTTP 方法

POST

描述

创建一个 ConsoleYAMLSample

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

dryRun

字符串

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

fieldValidation

字符串

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

body

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

200 - OK

ConsoleYAMLSample 模式

201 - 已创建

ConsoleYAMLSample 模式

202 - 已接受

ConsoleYAMLSample 模式

401 - 未授权

空

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

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

name

字符串

ConsoleYAMLSample 的名称
HTTP 方法

DELETE

描述

删除 ConsoleYAMLSample

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

dryRun

字符串

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

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

读取指定的 ConsoleYAMLSample

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

200 - OK

ConsoleYAMLSample 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 ConsoleYAMLSample

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

ConsoleYAMLSample 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 ConsoleYAMLSample

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

dryRun

字符串

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

fieldValidation

字符串

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

body

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

200 - OK

ConsoleYAMLSample 模式

201 - 已创建

ConsoleYAMLSample 模式

401 - 未授权

空