自定义资源定义 [apiextensions.k8s.io/v1] - 扩展 API | API 参考 | OpenShift 容器平台 4.17

规格
API 端点

描述

CustomResourceDefinition 表示应在 API 服务器上公开的资源。其名称必须采用 <.spec.name>.<.spec.group> 的格式。

类型

对象

必需

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`	`对象`	CustomResourceDefinitionSpec 描述用户希望其资源显示的方式
`status`	`对象`	CustomResourceDefinitionStatus 指示 CustomResourceDefinition 的状态

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

spec

对象

CustomResourceDefinitionSpec 描述用户希望其资源显示的方式

status

对象

CustomResourceDefinitionStatus 指示 CustomResourceDefinition 的状态

.spec

描述

CustomResourceDefinitionSpec 描述用户希望其资源显示的方式

类型

对象

必需

group
names
scope
versions

属性类型描述

属性	类型	描述
`conversion`	`对象`	CustomResourceConversion 描述如何转换 CR 的不同版本。
`group`	`字符串`	group 是定义的自定义资源的 API 组。自定义资源位于 `/apis/<group>/…` 下。必须与 CustomResourceDefinition 的名称匹配（格式为 `<names.plural>.<group>`）。
`names`	`对象`	CustomResourceDefinitionNames 指示要为此 CustomResourceDefinition 提供服务的名称
`preserveUnknownFields`	`布尔值`	`preserveUnknownFields` 指示在持久化到存储时是否保留 OpenAPI 模式中未指定的对象字段。`apiVersion`、`kind`、`metadata` 以及 `metadata` 中的已知字段始终保留。此字段已弃用，建议在 `spec.versions[*].schema.openAPIV3Schema` 中将 `x-preserve-unknown-fields` 设置为 true。详情请参见 https://kubernetes.ac.cn/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#field-pruning。
`scope`	`字符串`	`scope` 指示定义的自定义资源是集群范围的还是命名空间范围的。允许的值为 `Cluster` 和 `Namespaced`。
`versions`	`数组`	`versions` 是定义的自定义资源的所有 API 版本的列表。版本名称用于计算 API 发现中列出的已服务版本的顺序。“kube-like”风格的版本字符串将排在非“kube-like”风格的版本字符串之前，非“kube-like”风格的版本字符串按字典顺序排序。“Kube-like”版本的开头是“v”，后跟一个数字（主版本号），然后可以选择添加字符串“alpha”或“beta”以及另一个数字（次版本号）。这些版本首先按 GA > beta > alpha 的顺序排序（其中 GA 是没有 beta 或 alpha 等后缀的版本），然后按主版本号、次版本号比较排序。版本排序示例：v10、v2、v1、v11beta2、v10beta3、v3beta1、v12alpha1、v11alpha2、foo1、foo10。
`versions[]`	`对象`	`CustomResourceDefinitionVersion` 描述 CRD 的一个版本。

conversion

对象

CustomResourceConversion 描述如何转换 CR 的不同版本。

group

字符串

group 是定义的自定义资源的 API 组。自定义资源位于 /apis/<group>/… 下。必须与 CustomResourceDefinition 的名称匹配（格式为 <names.plural>.<group>）。

names

对象

CustomResourceDefinitionNames 指示要为此 CustomResourceDefinition 提供服务的名称

preserveUnknownFields

布尔值

preserveUnknownFields 指示在持久化到存储时是否保留 OpenAPI 模式中未指定的对象字段。apiVersion、kind、metadata 以及 metadata 中的已知字段始终保留。此字段已弃用，建议在 spec.versions[*].schema.openAPIV3Schema 中将 x-preserve-unknown-fields 设置为 true。详情请参见 https://kubernetes.ac.cn/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#field-pruning。

scope

字符串

scope 指示定义的自定义资源是集群范围的还是命名空间范围的。允许的值为 Cluster 和 Namespaced。

versions

数组

versions 是定义的自定义资源的所有 API 版本的列表。版本名称用于计算 API 发现中列出的已服务版本的顺序。“kube-like”风格的版本字符串将排在非“kube-like”风格的版本字符串之前，非“kube-like”风格的版本字符串按字典顺序排序。“Kube-like”版本的开头是“v”，后跟一个数字（主版本号），然后可以选择添加字符串“alpha”或“beta”以及另一个数字（次版本号）。这些版本首先按 GA > beta > alpha 的顺序排序（其中 GA 是没有 beta 或 alpha 等后缀的版本），然后按主版本号、次版本号比较排序。版本排序示例：v10、v2、v1、v11beta2、v10beta3、v3beta1、v12alpha1、v11alpha2、foo1、foo10。

versions[]

对象

CustomResourceDefinitionVersion 描述 CRD 的一个版本。

`.spec.conversion`

描述

CustomResourceConversion 描述如何转换 CR 的不同版本。

类型

对象

必需

strategy

属性类型描述

属性	类型	描述
`strategy`	`字符串`	`strategy` 指定如何将自定义资源在不同版本之间转换。允许的值为：- `"None"`：转换器只更改 `apiVersion`，不会修改自定义资源中的任何其他字段。- `"Webhook"`：API 服务器将调用外部 webhook 来执行转换。此选项需要其他信息。这需要 `spec.preserveUnknownFields` 为 false，并且 `spec.conversion.webhook` 已设置。
`webhook`	`对象`	`WebhookConversion` 描述如何调用转换 webhook。

strategy

字符串

strategy 指定如何将自定义资源在不同版本之间转换。允许的值为：- "None"：转换器只更改 apiVersion，不会修改自定义资源中的任何其他字段。- "Webhook"：API 服务器将调用外部 webhook 来执行转换。此选项需要其他信息。这需要 spec.preserveUnknownFields 为 false，并且 spec.conversion.webhook 已设置。

webhook

对象

WebhookConversion 描述如何调用转换 webhook。

`.spec.conversion.webhook`

描述

WebhookConversion 描述如何调用转换 webhook。

类型

对象

必需

conversionReviewVersions

属性类型描述

属性	类型	描述
`clientConfig`	`对象`	`WebhookClientConfig` 包含与 webhook 建立 TLS 连接所需的信息。
`conversionReviewVersions`	`数组 (字符串)`	`conversionReviewVersions` 是 Webhook 期望的 `ConversionReview` 版本的排序列表。API 服务器将使用列表中它支持的第一个版本。如果此列表中指定的版本均不受 API 服务器支持，则自定义资源的转换将失败。如果持久化的 Webhook 配置指定了允许的版本，但不包含 API 服务器已知的任何版本，则对 webhook 的调用将失败。

clientConfig

对象

WebhookClientConfig 包含与 webhook 建立 TLS 连接所需的信息。

conversionReviewVersions

数组 (字符串)

conversionReviewVersions 是 Webhook 期望的 ConversionReview 版本的排序列表。API 服务器将使用列表中它支持的第一个版本。如果此列表中指定的版本均不受 API 服务器支持，则自定义资源的转换将失败。如果持久化的 Webhook 配置指定了允许的版本，但不包含 API 服务器已知的任何版本，则对 webhook 的调用将失败。

`.spec.conversion.webhook.clientConfig`

描述: WebhookClientConfig 包含与 webhook 建立 TLS 连接所需的信息。
类型: 对象

属性类型描述

属性	类型	描述
`caBundle`	`字符串`	`caBundle` 是 PEM 编码的 CA 捆绑包，将用于验证 webhook 的服务器证书。如果未指定，则使用 apiserver 上的系统信任根。
`service`	`对象`	`ServiceReference` 包含对 `Service.legacy.k8s.io` 的引用。
`url`	`字符串`	`url` 提供 webhook 的位置，采用标准 URL 格式 (`scheme://host:port/path`)。必须且只能指定 `url` 或 `service` 之一。 `host` 不应引用在集群中运行的服务；请改用 `service` 字段。在某些 apiserver 中，主机可能通过外部 DNS 解析（例如，`kube-apiserver` 无法解析集群内 DNS，因为那将是分层冲突）。`host` 也可能是一个 IP 地址。请注意，除非您非常小心地在所有运行可能需要对此 webhook 进行调用的 apiserver 的主机上运行此 webhook，否则使用 `localhost` 或 `127.0.0.1` 作为 `host` 是有风险的。此类安装可能不可移植，即不容易在新集群中启动。方案必须为“https”；URL 必须以“https://”开头。路径是可选的，如果存在，可以是 URL 中允许的任何字符串。您可以使用路径将任意字符串传递给 webhook，例如集群标识符。尝试使用用户名或基本身份验证，例如“user:password@”是不允许的。片段（“#…”）和查询参数（“?……”）也不允许。

caBundle

字符串

caBundle 是 PEM 编码的 CA 捆绑包，将用于验证 webhook 的服务器证书。如果未指定，则使用 apiserver 上的系统信任根。

service

对象

ServiceReference 包含对 Service.legacy.k8s.io 的引用。

url

字符串

url 提供 webhook 的位置，采用标准 URL 格式 (scheme://host:port/path)。必须且只能指定 url 或 service 之一。

host 不应引用在集群中运行的服务；请改用 service 字段。在某些 apiserver 中，主机可能通过外部 DNS 解析（例如，kube-apiserver 无法解析集群内 DNS，因为那将是分层冲突）。host 也可能是一个 IP 地址。

请注意，除非您非常小心地在所有运行可能需要对此 webhook 进行调用的 apiserver 的主机上运行此 webhook，否则使用 localhost 或 127.0.0.1 作为 host 是有风险的。此类安装可能不可移植，即不容易在新集群中启动。

方案必须为“https”；URL 必须以“https://”开头。

路径是可选的，如果存在，可以是 URL 中允许的任何字符串。您可以使用路径将任意字符串传递给 webhook，例如集群标识符。

尝试使用用户名或基本身份验证，例如“user:password@”是不允许的。片段（“#…”）和查询参数（“?……”）也不允许。

`.spec.conversion.webhook.clientConfig.service`

描述

ServiceReference 包含对 Service.legacy.k8s.io 的引用。

类型

对象

必需

namespace
name

属性类型描述

属性	类型	描述
`name`	`字符串`	`name` 是服务的名称。必填
`namespace`	`字符串`	`namespace` 是服务的命名空间。必填
`path`	`字符串`	`path` 是 webhook 将被联系到的可选 URL 路径。
`port`	`整数`	`port` 是 webhook 将被联系到的可选服务端口。`port` 应为有效的端口号（1-65535，含）。默认为 443，以确保向后兼容。

name

字符串

name 是服务的名称。必填

namespace

字符串

namespace 是服务的命名空间。必填

path

字符串

path 是 webhook 将被联系到的可选 URL 路径。

port

整数

port 是 webhook 将被联系到的可选服务端口。port 应为有效的端口号（1-65535，含）。默认为 443，以确保向后兼容。

`.spec.names`

描述

CustomResourceDefinitionNames 指示要为此 CustomResourceDefinition 提供服务的名称

类型

对象

必需

plural
kind

属性类型描述

属性	类型	描述
`categories`	`数组 (字符串)`	`categories` 是此自定义资源所属的已分组资源的列表（例如“all”）。这在 API 发现文档中发布，并由客户端用于支持诸如 `kubectl get all` 之类的调用。
`kind`	`字符串`	`kind` 是资源的序列化类型。它通常是大驼峰式命名且是单数形式。自定义资源实例将此值用作 API 调用中的 `kind` 属性。
`listKind`	`字符串`	`listKind` 是此资源列表的序列化类型。默认为“`kind`List”。
`plural`	`字符串`	`plural` 是要服务的资源的复数名称。自定义资源在 `/apis///…/` 下提供服务。必须与 CustomResourceDefinition 的名称匹配（格式为 `.`）。必须全部小写。
`shortNames`	`数组 (字符串)`	`shortNames` 是资源的简称，在 API 发现文档中公开，并由客户端用于支持诸如 `kubectl get` 之类的调用。它必须全部小写。
`singular`	`字符串`	`singular` 是资源的单数名称。它必须全部小写。默认为小写的 `kind`。

categories

数组 (字符串)

categories 是此自定义资源所属的已分组资源的列表（例如“all”）。这在 API 发现文档中发布，并由客户端用于支持诸如 kubectl get all 之类的调用。

kind

字符串

kind 是资源的序列化类型。它通常是大驼峰式命名且是单数形式。自定义资源实例将此值用作 API 调用中的 kind 属性。

listKind

字符串

listKind 是此资源列表的序列化类型。默认为“`kind`List”。

plural

字符串

plural 是要服务的资源的复数名称。自定义资源在 /apis///…/ 下提供服务。必须与 CustomResourceDefinition 的名称匹配（格式为 .）。必须全部小写。

shortNames

数组 (字符串)

shortNames 是资源的简称，在 API 发现文档中公开，并由客户端用于支持诸如 kubectl get 之类的调用。它必须全部小写。

singular

字符串

singular 是资源的单数名称。它必须全部小写。默认为小写的 kind。

`.spec.versions`

描述: versions 是定义的自定义资源的所有 API 版本的列表。版本名称用于计算 API 发现中列出的已服务版本的顺序。“kube-like”风格的版本字符串将排在非“kube-like”风格的版本字符串之前，非“kube-like”风格的版本字符串按字典顺序排序。“Kube-like”版本的开头是“v”，后跟一个数字（主版本号），然后可以选择添加字符串“alpha”或“beta”以及另一个数字（次版本号）。这些版本首先按 GA > beta > alpha 的顺序排序（其中 GA 是没有 beta 或 alpha 等后缀的版本），然后按主版本号、次版本号比较排序。版本排序示例：v10、v2、v1、v11beta2、v10beta3、v3beta1、v12alpha1、v11alpha2、foo1、foo10。
类型: 数组

`.spec.versions[]`

描述

CustomResourceDefinitionVersion 描述 CRD 的一个版本。

类型

对象

必需

name
served
storage

属性类型描述

属性	类型	描述
`additionalPrinterColumns`	`数组`	`additionalPrinterColumns` 指定在表输出中返回的其他列。详情请参见 https://kubernetes.ac.cn/docs/reference/using-api/api-concepts/#receiving-resources-as-tables。如果未指定任何列，则使用显示自定义资源年龄的单列。
`additionalPrinterColumns[]`	`对象`	`CustomResourceColumnDefinition` 指定服务器端打印的列。
`deprecated`	`布尔值`	`deprecated` 指示此版本的自定义资源 API 已弃用。设置为 true 时，对该版本的 API 请求将在服务器响应中收到警告标头。默认为 false。
`deprecationWarning`	`字符串`	`deprecationWarning` 覆盖了返回给 API 客户端的默认警告。只有在 `deprecated` 为 true 时才能设置。默认警告指示此版本已弃用，并建议使用相同或更高稳定性的最新版本（如果存在）。
`name`	`字符串`	`name` 是版本名称，例如“v1”、“v2beta1”等。如果 `served` 为 true，则自定义资源将在 `/apis/<group>/<version>/…` 下提供服务。
`schema`	`对象`	`CustomResourceValidation` 是自定义资源验证方法的列表。
`selectableFields`	`数组`	`selectableFields` 指定可以用作字段选择器的字段路径。最多允许 8 个可选择的字段。参见 https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/field-selectors
`selectableFields[]`	`对象`	`SelectableField` 指定可以用字段选择器使用的字段的 JSON 路径。
`served`	`布尔值`	`served` 是一个标志，用于启用/禁用通过 REST API 提供此版本。
`storage`	`布尔值`	`storage` 指示在将自定义资源持久化到存储时应使用此版本。必须只有一个版本具有 `storage=true`。
`subresources`	`对象`	`CustomResourceSubresources` 定义自定义资源的状态和规模子资源。

additionalPrinterColumns

数组

additionalPrinterColumns 指定在表输出中返回的其他列。详情请参见 https://kubernetes.ac.cn/docs/reference/using-api/api-concepts/#receiving-resources-as-tables。如果未指定任何列，则使用显示自定义资源年龄的单列。

additionalPrinterColumns[]

对象

CustomResourceColumnDefinition 指定服务器端打印的列。

deprecated

布尔值

deprecated 指示此版本的自定义资源 API 已弃用。设置为 true 时，对该版本的 API 请求将在服务器响应中收到警告标头。默认为 false。

deprecationWarning

字符串

deprecationWarning 覆盖了返回给 API 客户端的默认警告。只有在 deprecated 为 true 时才能设置。默认警告指示此版本已弃用，并建议使用相同或更高稳定性的最新版本（如果存在）。

name

字符串

name 是版本名称，例如“v1”、“v2beta1”等。如果 served 为 true，则自定义资源将在 /apis/<group>/<version>/… 下提供服务。

schema

对象

CustomResourceValidation 是自定义资源验证方法的列表。

selectableFields

数组

selectableFields 指定可以用作字段选择器的字段路径。最多允许 8 个可选择的字段。参见 https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/field-selectors

selectableFields[]

对象

SelectableField 指定可以用字段选择器使用的字段的 JSON 路径。

served

布尔值

served 是一个标志，用于启用/禁用通过 REST API 提供此版本。

storage

布尔值

storage 指示在将自定义资源持久化到存储时应使用此版本。必须只有一个版本具有 storage=true。

subresources

对象

CustomResourceSubresources 定义自定义资源的状态和规模子资源。

.spec.versions[].additionalPrinterColumns

描述: additionalPrinterColumns 指定在表输出中返回的其他列。详情请参见 https://kubernetes.ac.cn/docs/reference/using-api/api-concepts/#receiving-resources-as-tables。如果未指定任何列，则使用显示自定义资源年龄的单列。
类型: 数组

.spec.versions[].additionalPrinterColumns[]

描述

CustomResourceColumnDefinition 指定服务器端打印的列。

类型

对象

必需

name
type
jsonPath

属性类型描述

属性	类型	描述
`description`	`字符串`	`description` 是此列的人类可读描述。
`format`	`字符串`	`format` 是此列的可选 OpenAPI 类型定义。“name” 格式应用于主标识符列，以帮助客户端识别该列是资源名称。详情请参见 https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types。
`jsonPath`	`字符串`	`jsonPath` 是一个简单的 JSON 路径（即带有数组表示法），它针对每个自定义资源进行评估以生成此列的值。
`name`	`字符串`	`name` 是列的人类可读名称。
`priority`	`整数`	`priority` 是一个整数，定义了此列与其他列相比的相对重要性。较小的数字被认为是较高的优先级。在空间有限的情况下可能被省略的列应设置优先级大于 0。
`type`	`字符串`	`type` 是此列的 OpenAPI 类型定义。详情请参见 https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types。

description

字符串

description 是此列的人类可读描述。

format

字符串

format 是此列的可选 OpenAPI 类型定义。“name” 格式应用于主标识符列，以帮助客户端识别该列是资源名称。详情请参见 https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types。

jsonPath

字符串

jsonPath 是一个简单的 JSON 路径（即带有数组表示法），它针对每个自定义资源进行评估以生成此列的值。

name

字符串

name 是列的人类可读名称。

priority

整数

priority 是一个整数，定义了此列与其他列相比的相对重要性。较小的数字被认为是较高的优先级。在空间有限的情况下可能被省略的列应设置优先级大于 0。

type

字符串

type 是此列的 OpenAPI 类型定义。详情请参见 https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types。

.spec.versions[].schema

描述: CustomResourceValidation 是自定义资源验证方法的列表。
类型: 对象

属性类型描述

属性	类型	描述
`openAPIV3Schema`	``	`openAPIV3Schema` 是用于验证和修剪的 OpenAPI v3 模式。

openAPIV3Schema

openAPIV3Schema 是用于验证和修剪的 OpenAPI v3 模式。

.spec.versions[].selectableFields

描述: selectableFields 指定可以用作字段选择器的字段路径。最多允许 8 个可选择的字段。参见 https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/field-selectors
类型: 数组

.spec.versions[].selectableFields[]

描述

SelectableField 指定可以用字段选择器使用的字段的 JSON 路径。

类型

对象

必需

jsonPath

属性类型描述

属性	类型	描述
`jsonPath`	`字符串`	`jsonPath` 是一个简单的 JSON 路径，它针对每个自定义资源进行评估以生成字段选择器值。仅允许不带数组表示法的 JSON 路径。必须指向字符串、布尔值或整数类型的字段。允许具有枚举值和格式的字符串类型。如果 jsonPath 指向资源中不存在的字段，则 jsonPath 评估结果为空字符串。不得指向元数据字段。必填。

jsonPath

字符串

jsonPath 是一个简单的 JSON 路径，它针对每个自定义资源进行评估以生成字段选择器值。仅允许不带数组表示法的 JSON 路径。必须指向字符串、布尔值或整数类型的字段。允许具有枚举值和格式的字符串类型。如果 jsonPath 指向资源中不存在的字段，则 jsonPath 评估结果为空字符串。不得指向元数据字段。必填。

.spec.versions[].subresources

描述: CustomResourceSubresources 定义自定义资源的状态和规模子资源。
类型: 对象

属性类型描述

属性	类型	描述
`scale`	`对象`	`CustomResourceSubresourceScale` 定义如何为自定义资源提供规模子资源。
`status`	`对象`	`CustomResourceSubresourceStatus` 定义如何为自定义资源提供状态子资源。状态由自定义资源内的 `.status` JSON 路径表示。设置后，* 公开自定义资源的 /status 子资源 * 对 /status 子资源的 PUT 请求采用自定义资源对象，并忽略除状态节以外的任何更改 * 对自定义资源的 PUT/POST/PATCH 请求忽略对状态节的更改

scale

对象

CustomResourceSubresourceScale 定义如何为自定义资源提供规模子资源。

status

对象

CustomResourceSubresourceStatus 定义如何为自定义资源提供状态子资源。状态由自定义资源内的 .status JSON 路径表示。设置后，* 公开自定义资源的 /status 子资源 * 对 /status 子资源的 PUT 请求采用自定义资源对象，并忽略除状态节以外的任何更改 * 对自定义资源的 PUT/POST/PATCH 请求忽略对状态节的更改

.spec.versions[].subresources.scale

描述

CustomResourceSubresourceScale 定义如何为自定义资源提供规模子资源。

类型

对象

必需

specReplicasPath
statusReplicasPath

属性类型描述

属性	类型	描述
`labelSelectorPath`	`字符串`	`labelSelectorPath` 定义自定义资源内对应于 Scale `status.selector` 的 JSON 路径。仅允许不带数组表示法的 JSON 路径。必须是 `.status` 或 `.spec` 下的 JSON 路径。必须设置为与 HorizontalPodAutoscaler 一起使用。此 JSON 路径指向的字段必须是字符串字段（而不是复杂的 selector 结构），其中包含以字符串形式序列化的标签选择器。更多信息： https://kubernetes.ac.cn/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource 如果自定义资源中给定路径下没有值，则 `/scale` 子资源中的 `status.selector` 值将默认为空字符串。
`specReplicasPath`	`字符串`	`specReplicasPath` 定义自定义资源内对应于 Scale `spec.replicas` 的 JSON 路径。仅允许不带数组表示法的 JSON 路径。必须是 `.spec` 下的 JSON 路径。如果自定义资源中给定路径下没有值，则 `/scale` 子资源将在 GET 时返回错误。
`statusReplicasPath`	`字符串`	`statusReplicasPath` 定义自定义资源内对应于 Scale `status.replicas` 的 JSON 路径。仅允许不带数组表示法的 JSON 路径。必须是 `.status` 下的 JSON 路径。如果自定义资源中给定路径下没有值，则 `/scale` 子资源中的 `status.replicas` 值将默认为 0。

labelSelectorPath

字符串

labelSelectorPath 定义自定义资源内对应于 Scale status.selector 的 JSON 路径。仅允许不带数组表示法的 JSON 路径。必须是 .status 或 .spec 下的 JSON 路径。必须设置为与 HorizontalPodAutoscaler 一起使用。此 JSON 路径指向的字段必须是字符串字段（而不是复杂的 selector 结构），其中包含以字符串形式序列化的标签选择器。更多信息： https://kubernetes.ac.cn/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource 如果自定义资源中给定路径下没有值，则 /scale 子资源中的 status.selector 值将默认为空字符串。

specReplicasPath

字符串

specReplicasPath 定义自定义资源内对应于 Scale spec.replicas 的 JSON 路径。仅允许不带数组表示法的 JSON 路径。必须是 .spec 下的 JSON 路径。如果自定义资源中给定路径下没有值，则 /scale 子资源将在 GET 时返回错误。

statusReplicasPath

字符串

statusReplicasPath 定义自定义资源内对应于 Scale status.replicas 的 JSON 路径。仅允许不带数组表示法的 JSON 路径。必须是 .status 下的 JSON 路径。如果自定义资源中给定路径下没有值，则 /scale 子资源中的 status.replicas 值将默认为 0。

.spec.versions[].subresources.status

描述: CustomResourceSubresourceStatus 定义如何为自定义资源提供状态子资源。状态由自定义资源内的 .status JSON 路径表示。设置后，* 公开自定义资源的 /status 子资源 * 对 /status 子资源的 PUT 请求采用自定义资源对象，并忽略除状态节以外的任何更改 * 对自定义资源的 PUT/POST/PATCH 请求忽略对状态节的更改
类型: 对象

.status

描述: CustomResourceDefinitionStatus 指示 CustomResourceDefinition 的状态
类型: 对象

属性类型描述

属性	类型	描述
`acceptedNames`	`对象`	CustomResourceDefinitionNames 指示要为此 CustomResourceDefinition 提供服务的名称
`conditions`	`数组`	`conditions` 指示自定义资源定义特定方面的状态
`conditions[]`	`对象`	`CustomResourceDefinitionCondition` 包含此 Pod 当前条件的详细信息。
`storedVersions`	`数组 (字符串)`	`storedVersions` 列出曾经持久化的所有版本的自定义资源。跟踪这些版本允许为 etcd 中存储的版本提供迁移路径。该字段是可变的，因此迁移控制器可以完成对另一个版本的迁移（确保存储中没有留下旧对象），然后从此列表中删除其余版本。当这些版本存在于此列表中时，不得从 `spec.versions` 中删除它们。

acceptedNames

对象

CustomResourceDefinitionNames 指示要为此 CustomResourceDefinition 提供服务的名称

conditions

数组

conditions 指示自定义资源定义特定方面的状态

conditions[]

对象

CustomResourceDefinitionCondition 包含此 Pod 当前条件的详细信息。

storedVersions

数组 (字符串)

storedVersions 列出曾经持久化的所有版本的自定义资源。跟踪这些版本允许为 etcd 中存储的版本提供迁移路径。该字段是可变的，因此迁移控制器可以完成对另一个版本的迁移（确保存储中没有留下旧对象），然后从此列表中删除其余版本。当这些版本存在于此列表中时，不得从 spec.versions 中删除它们。

.status.acceptedNames

描述

CustomResourceDefinitionNames 指示要为此 CustomResourceDefinition 提供服务的名称

类型

对象

必需

plural
kind

属性类型描述

属性	类型	描述
`categories`	`数组 (字符串)`	`categories` 是此自定义资源所属的已分组资源的列表（例如“all”）。这在 API 发现文档中发布，并由客户端用于支持诸如 `kubectl get all` 之类的调用。
`kind`	`字符串`	`kind` 是资源的序列化类型。它通常是大驼峰式命名且是单数形式。自定义资源实例将此值用作 API 调用中的 `kind` 属性。
`listKind`	`字符串`	`listKind` 是此资源列表的序列化类型。默认为“`kind`List”。
`plural`	`字符串`	`plural` 是要服务的资源的复数名称。自定义资源在 `/apis///…/` 下提供服务。必须与 CustomResourceDefinition 的名称匹配（格式为 `.`）。必须全部小写。
`shortNames`	`数组 (字符串)`	`shortNames` 是资源的简称，在 API 发现文档中公开，并由客户端用于支持诸如 `kubectl get` 之类的调用。它必须全部小写。
`singular`	`字符串`	`singular` 是资源的单数名称。它必须全部小写。默认为小写的 `kind`。

categories

数组 (字符串)

categories 是此自定义资源所属的已分组资源的列表（例如“all”）。这在 API 发现文档中发布，并由客户端用于支持诸如 kubectl get all 之类的调用。

kind

字符串

kind 是资源的序列化类型。它通常是大驼峰式命名且是单数形式。自定义资源实例将此值用作 API 调用中的 kind 属性。

listKind

字符串

listKind 是此资源列表的序列化类型。默认为“`kind`List”。

plural

字符串

plural 是要服务的资源的复数名称。自定义资源在 /apis///…/ 下提供服务。必须与 CustomResourceDefinition 的名称匹配（格式为 .）。必须全部小写。

shortNames

数组 (字符串)

shortNames 是资源的简称，在 API 发现文档中公开，并由客户端用于支持诸如 kubectl get 之类的调用。它必须全部小写。

singular

字符串

singular 是资源的单数名称。它必须全部小写。默认为小写的 kind。

.status.conditions

描述: conditions 指示自定义资源定义特定方面的状态
类型: 数组

.status.conditions[]

描述

CustomResourceDefinitionCondition 包含此 Pod 当前条件的详细信息。

类型

对象

必需

type
status

属性类型描述

属性	类型	描述
`lastTransitionTime`	`Time`	`lastTransitionTime` 条件从一种状态转换到另一种状态的最后时间。
`message`	`字符串`	`message` 是一个人类可读的消息，指示有关最后转换的详细信息。
`reason`	`字符串`	`reason` 是条件最后转换的唯一、单字、驼峰式原因。
`status`	`字符串`	`status` 是条件的状态。可以是 True、False、Unknown。
`type`	`字符串`	`type` 是条件的类型。类型包括 Established、NamesAccepted 和 Terminating。

lastTransitionTime

Time

lastTransitionTime 条件从一种状态转换到另一种状态的最后时间。

message

字符串

message 是一个人类可读的消息，指示有关最后转换的详细信息。

reason

字符串

reason 是条件最后转换的唯一、单字、驼峰式原因。

status

字符串

status 是条件的状态。可以是 True、False、Unknown。

type

字符串

type 是条件的类型。类型包括 Established、NamesAccepted 和 Terminating。

API 端点

以下 API 端点可用

/apis/apiextensions.k8s.io/v1/customresourcedefinitions
- DELETE: 删除 CustomResourceDefinition 集合
- GET: 列出或监听 CustomResourceDefinition 对象
- POST: 创建 CustomResourceDefinition
/apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions
- GET: 监听 CustomResourceDefinition 列表的单个更改。已弃用：请改用列表操作中的“watch”参数。
/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}
- DELETE: 删除 CustomResourceDefinition
- GET: 读取指定的 CustomResourceDefinition
- PATCH: 部分更新指定的 CustomResourceDefinition
- PUT: 替换指定的 CustomResourceDefinition
/apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions/{name}
- GET: 监听 CustomResourceDefinition 对象的更改。已弃用：请改用列表操作中的“watch”参数，并使用“fieldSelector”参数过滤为单个项目。
/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status
- GET: 读取指定的 CustomResourceDefinition 的状态
- PATCH: 部分更新指定的 CustomResourceDefinition 的状态
- PUT: 替换指定的 CustomResourceDefinition 的状态

/apis/apiextensions.k8s.io/v1/customresourcedefinitions

HTTP 方法: DELETE
描述: 删除 CustomResourceDefinition 集合

表 1. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

表 2. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - 未授权	空

HTTP 方法: GET
描述: 列出或监听 CustomResourceDefinition 对象

表 3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`CustomResourceDefinitionList` 模式
401 - 未授权	空

HTTP 方法: POST
描述: 创建 CustomResourceDefinition

表 4. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并且将忽略解码器遇到的所有重复字段（只保留最后一个）。这是 v1.23 之前的默认行为。- Warn：对于从对象中删除的每个未知字段以及遇到的每个重复字段，这将通过标准警告响应标头发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将导致请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 5. 请求体参数
参数	类型	描述
`body`	`CustomResourceDefinition` 模式

表 6. HTTP 响应
HTTP 代码	响应正文
200 - OK	`CustomResourceDefinition` 模式
201 - 已创建	`CustomResourceDefinition` 模式
202 - 已接受	`CustomResourceDefinition` 模式
401 - 未授权	空

/apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions

HTTP 方法: GET
描述: 监听 CustomResourceDefinition 列表的单个更改。已弃用：请改用列表操作中的“watch”参数。

表 7. HTTP 响应
HTTP 代码	响应正文
200 - OK	`WatchEvent` 模式
401 - 未授权	空

/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}

表 8. 全局路径参数
参数	类型	描述
`name`	`字符串`	CustomResourceDefinition 的名称

HTTP 方法: DELETE
描述: 删除 CustomResourceDefinition

表 9. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

表 10. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - 已接受	`Status` 模式
401 - 未授权	空

HTTP 方法: GET
描述: 读取指定的 CustomResourceDefinition

表 11. HTTP 响应
HTTP 代码	响应正文
200 - OK	`CustomResourceDefinition` 模式
401 - 未授权	空

HTTP 方法: PATCH
描述: 部分更新指定的 CustomResourceDefinition

表 12. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并且将忽略解码器遇到的所有重复字段（只保留最后一个）。这是 v1.23 之前的默认行为。- Warn：对于从对象中删除的每个未知字段以及遇到的每个重复字段，这将通过标准警告响应标头发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将导致请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`CustomResourceDefinition` 模式
201 - 已创建	`CustomResourceDefinition` 模式
401 - 未授权	空

HTTP 方法: PUT
描述: 替换指定的 CustomResourceDefinition

表 14. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并且将忽略解码器遇到的所有重复字段（只保留最后一个）。这是 v1.23 之前的默认行为。- Warn：对于从对象中删除的每个未知字段以及遇到的每个重复字段，这将通过标准警告响应标头发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将导致请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 15. 请求体参数
参数	类型	描述
`body`	`CustomResourceDefinition` 模式

表 16. HTTP 响应
HTTP 代码	响应正文
200 - OK	`CustomResourceDefinition` 模式
201 - 已创建	`CustomResourceDefinition` 模式
401 - 未授权	空

/apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions/{name}

表 17. 全局路径参数
参数	类型	描述
`name`	`字符串`	CustomResourceDefinition 的名称

HTTP 方法: GET
描述: 监听 CustomResourceDefinition 对象的更改。已弃用：请改用列表操作中的“watch”参数，并使用“fieldSelector”参数过滤为单个项目。

表 18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`WatchEvent` 模式
401 - 未授权	空

/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status

表 19. 全局路径参数
参数	类型	描述
`name`	`字符串`	CustomResourceDefinition 的名称

HTTP 方法: GET
描述: 读取指定的 CustomResourceDefinition 的状态

表 20. HTTP 响应
HTTP 代码	响应正文
200 - OK	`CustomResourceDefinition` 模式
401 - 未授权	空

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

表 21. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并且将忽略解码器遇到的所有重复字段（只保留最后一个）。这是 v1.23 之前的默认行为。- Warn：对于从对象中删除的每个未知字段以及遇到的每个重复字段，这将通过标准警告响应标头发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将导致请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 22. HTTP 响应
HTTP 代码	响应正文
200 - OK	`CustomResourceDefinition` 模式
201 - 已创建	`CustomResourceDefinition` 模式
401 - 未授权	空

HTTP 方法: PUT
描述: 替换指定的 CustomResourceDefinition 的状态

表 23. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并且将忽略解码器遇到的所有重复字段（只保留最后一个）。这是 v1.23 之前的默认行为。- Warn：对于从对象中删除的每个未知字段以及遇到的每个重复字段，这将通过标准警告响应标头发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将导致请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 24. 请求体参数
参数	类型	描述
`body`	`CustomResourceDefinition` 模式

表 25. HTTP 响应
HTTP 代码	响应正文
200 - OK	`CustomResourceDefinition` 模式
201 - 已创建	`CustomResourceDefinition` 模式
401 - 未授权	空