10.3. CustomResourceDefinition [apiextensions.k8s.io/v1]


描述
类型
对象
必填
  • spec

10.3.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

spec

对象

status

对象

10.3.1.1. .spec

描述
类型
对象
必填
  • group
  • scope
Expand
属性类型描述

对象

group

字符串

对象

preserveUnknownFields

布尔值

scope

字符串

array

versions[]

对象

10.3.1.2. .spec.conversion

描述
类型
对象
必填
Expand
属性类型描述

字符串

webhook

对象

10.3.1.3. .spec.conversion.webhook

描述
类型
对象
必填
  • conversionReviewVersions
Expand
属性类型描述

clientConfig

对象

conversionReviewVersions

数组(字符串)

10.3.1.4. .spec.conversion.webhook.clientConfig

描述
类型
对象
Expand
属性类型描述

caBundle

字符串

service

对象

url

字符串

10.3.1.5. .spec.conversion.webhook.clientConfig.service

描述
类型
对象
必填
  • namespace
  • name
Expand
属性类型描述

name

字符串

必填

namespace

字符串

必填

path

字符串

port

整数

10.3.1.6. .spec.names

描述
类型
对象
必填
  • kind
Expand
属性类型描述

数组(字符串)

kind

字符串

listKind

字符串

字符串

shortNames

数组(字符串)

字符串

10.3.1.7. .spec.versions

描述
类型
array

10.3.1.8. .spec.versions[]

描述
类型
对象
必填
  • name
  • storage
Expand
属性类型描述

additionalPrinterColumns

array

additionalPrinterColumns[]

对象

已弃用

布尔值

默认为false。

deprecationWarning

字符串

name

字符串

schema

对象

布尔值

storage

布尔值

对象

10.3.1.9. .spec.versions[].additionalPrinterColumns

描述
类型
array

10.3.1.10. .spec.versions[].additionalPrinterColumns[]

描述
类型
对象
必填
  • name
  • type
  • jsonPath
Expand
属性类型描述

description

字符串

格式

字符串

jsonPath

字符串

name

字符串

priority

整数

type

字符串

10.3.1.11. .spec.versions[].schema

描述
类型
对象
Expand
属性类型描述

openAPIV3Schema

``

10.3.1.12. .spec.versions[].subresources

描述
类型
对象
Expand
属性类型描述

scale

对象

status

对象

10.3.1.13. .spec.versions[].subresources.scale

描述
类型
对象
必填
  • specReplicasPath
  • statusReplicasPath
Expand
属性类型描述

labelSelectorPath

字符串

specReplicasPath

字符串

statusReplicasPath

字符串

10.3.1.14. .spec.versions[].subresources.status

描述
类型
对象

10.3.1.15. .status

描述
类型
对象
Expand
属性类型描述

acceptedNames

对象

conditions

array

conditions[]

对象

storedVersions

数组(字符串)

10.3.1.16. .status.acceptedNames

描述
类型
对象
必填
  • kind
Expand
属性类型描述

数组(字符串)

kind

字符串

listKind

字符串

字符串

shortNames

数组(字符串)

字符串

10.3.1.17. .status.conditions

描述
类型
array

10.3.1.18. .status.conditions[]

描述
类型
对象
必填
  • type
  • status
Expand
属性类型描述

lastTransitionTime

message

字符串

reason

字符串

status

字符串

可以是 True, False, Unknown。

type

字符串

10.3.2. API 端点

可用的 API 端点如下:

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

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

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

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

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

Expand
表 10.36. 全局查询参数
参数类型描述

pretty

字符串

HTTP 方法
DELETE
描述
Expand
表 10.37. 查询参数
参数类型描述

继续

字符串

从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldSelector

字符串

默认为任何内容。

gracePeriodSeconds

整数

labelSelector

字符串

默认为任何内容。

limit

整数

orphanDependents

布尔值

propagationPolicy

字符串

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

默认为未设置

timeoutSeconds

整数

Expand
表 10.38. 主体参数
参数类型描述

正文(body)

 
Expand
表 10.39. HTTP 响应
HTTP 代码响应正文

200 - OK

401 - Unauthorized

HTTP 方法
GET
描述
Expand
表 10.40. 查询参数
参数类型描述

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。

继续

字符串

从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。

fieldSelector

字符串

默认为任何内容。

labelSelector

字符串

默认为任何内容。

limit

整数

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

默认为未设置

timeoutSeconds

整数

watch

布尔值

Expand
表 10.41. HTTP 响应
HTTP 代码响应正文

200 - OK

CustomResourceDefinitionList schema

401 - Unauthorized

HTTP 方法
POST
描述
Expand
表 10.42. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 10.43. 主体参数
参数类型描述

正文(body)

 
Expand
表 10.44. HTTP 响应
HTTP 代码响应正文

200 - OK

201 - Created

202 - Accepted

401 - Unauthorized

Expand
表 10.45. 全局查询参数
参数类型描述

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。

继续

字符串

从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。

fieldSelector

字符串

默认为任何内容。

labelSelector

字符串

默认为任何内容。

limit

整数

pretty

字符串

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

默认为未设置

timeoutSeconds

整数

watch

布尔值

HTTP 方法
GET
描述
Expand
表 10.46. HTTP 响应
HTTP 代码响应正文

200 - OK

401 - Unauthorized

Expand
表 10.47. 
参数类型描述

name

字符串

Expand
表 10.48. 全局查询参数
参数类型描述

pretty

字符串

HTTP 方法
DELETE
描述
Expand
表 10.49. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

gracePeriodSeconds

整数

orphanDependents

布尔值

propagationPolicy

字符串

Expand
表 10.50. 主体参数
参数类型描述

正文(body)

 
Expand
表 10.51. HTTP 响应
HTTP 代码响应正文

200 - OK

202 - Accepted

401 - Unauthorized

HTTP 方法
GET
描述
Expand
表 10.52. HTTP 响应
HTTP 代码响应正文

200 - OK

401 - Unauthorized

HTTP 方法
PATCH
描述
Expand
表 10.53. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

force

布尔值

Expand
表 10.54. 主体参数
参数类型描述

正文(body)

 
Expand
表 10.55. HTTP 响应
HTTP 代码响应正文

200 - OK

201 - Created

401 - Unauthorized

HTTP 方法
PUT
描述
Expand
表 10.56. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 10.57. 主体参数
参数类型描述

正文(body)

CustomResourceDefinition 模式

 
Expand
表 10.58. HTTP 响应
HTTP 代码响应正文

200 - OK

CustomResourceDefinition 模式

201 - Created

CustomResourceDefinition 模式

401 - Unauthorized

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

name

字符串

CustomResourceDefinition 的名称

Expand
表 10.60. 全局查询参数
参数类型描述

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 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象,则返回第一次列表结果时存在的对象版本。

pretty

字符串

如果 'true',则输出被用户友善。

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。

HTTP 方法
GET
描述
观察对类型为 CustomResourceDefinition 的对象的更改。已弃用:使用带有列表操作的 'watch' 参数,而是过滤到带有 'fieldSelector' 参数的单个项目。
Expand
表 10.61. HTTP 响应
HTTP 代码响应正文

200 - OK

WatchEvent 模式

401 - Unauthorized

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

name

字符串

CustomResourceDefinition 的名称

Expand
表 10.63. 全局查询参数
参数类型描述

pretty

字符串

如果 'true',则输出被用户友善。

HTTP 方法
GET
描述
指定 CustomResourceDefinition 的读取状态
Expand
表 10.64. HTTP 响应
HTTP 代码响应正文

200 - OK

CustomResourceDefinition 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
指定 CustomResourceDefinition 的部分更新状态
Expand
表 10.65. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求(application/apply-patch)需要此字段,但对于非应用补丁类型(JsonPatch、MergePatch、OptMergePatch)是可选的。

force

布尔值

强制将"强制"应用请求。这意味着用户会重新清空由其他人员拥有的冲突字段。对于非应用补丁请求,必须取消设置 force 标志。

Expand
表 10.66. 主体参数
参数类型描述

正文(body)

Patch 模式

 
Expand
表 10.67. HTTP 响应
HTTP 代码响应正文

200 - OK

CustomResourceDefinition 模式

201 - Created

CustomResourceDefinition 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定 CustomResourceDefinition 的状态
Expand
表 10.68. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 10.69. 主体参数
参数类型描述

正文(body)

CustomResourceDefinition 模式

 
Expand
表 10.70. HTTP 响应
HTTP 代码响应正文

200 - OK

CustomResourceDefinition 模式

201 - Created

CustomResourceDefinition 模式

401 - Unauthorized

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2025 Red Hat