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

转换

对象

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

group

字符串

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

names

对象

CustomResourceDefinitionNames 表示为这个 CustomResourceDefinition 提供的名称

preserveUnknownFields

布尔值

preserveUnknownFields 表示在保留存储时不应保留 OpenAPI 模式中指定的对象字段。元数据中的元数据、元数据和已知字段总是被保留。此字段已弃用，在 spec.versions[*].schema.openAPIV3Schema 中将 x-preserve-unknown-fields 设置为 true。详情请查看 https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#field-pruning。

scope

字符串

Scope 表示定义的自定义资源是 cluster- 或 namespace-scoped。允许的值是 Cluster 和 Namespaced。

版本

array

version 是定义的自定义资源的所有 API 版本列表。版本名称用于计算在 API 发现中列出提供版本的顺序。如果版本字符串为 "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 的版本。

策略

字符串

strategy 指定自定义资源在版本之间转换的方式。允许的值有： - "None": converter 只更改 apiVersion，并不会影响自定义资源中的任何其他字段。- "Webhook": API 服务器将调用一个外部 webhook 以进行转换。此选项需要额外的信息。这需要 spec.preserveUnknownFields 为 false，并且设置 spec.conversion.webhook。

webhook

对象

WebhookConversion 描述了如何调用转换 Webhook

clientConfig

对象

WebhookClientConfig 包含用于与 webhook 进行 TLS 连接的信息。

conversionReviewVersions

数组（字符串）

conversionReviewVersions 是 Webhook 期望的首选 ConversionReview 版本的顺序列表。API 服务器将使用支持的列表中的第一个版本。如果 API 服务器不支持此列表中指定的任何版本，则转换将失败。如果持久的 Webhook 配置指定允许的版本，且不包含任何 API 服务器已知的版本，则对 Webhook 的调用将失败。

caBundle

字符串

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

service

对象

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

url

字符串

URL 以标准 URL 格式提供 webhook 的位置(scheme://host:port/path)。必须指定 url 或服务 中的一个。

主机 不应引用集群中运行的服务；使用 service 字段。在一些 apiservers 中，主机可以通过外部 DNS 解析（例如，kube-apiserver 无法解析集群内部 DNS，因为这将是一个分层违反情况）。主机 也可以是 IP 地址。

请注意，使用 localhost 或 127.0.0.1 作为主机有风险，除非您特别注意在运行 apiserver 的主机上运行此 webhook，这可能需要对此 webhook 发出调用。此类安装可能不可移植，即无法在新集群中启动。

方案必须是 "https"；URL 必须以 "https://" 开头。

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

不允许使用用户或基本身份验证，如 "user:password@"。不允许 slices ("""…​")和查询参数("?…​")。

name

字符串

name 是服务的名称。必填

namespace

字符串

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

path

字符串

path 是要联系 Webhook 的可选 URL 路径。

port

整数

port 是要联系 Webhook 的可选服务端口。port 应该是有效的端口号(1-65535，含)。默认为 443，以便向后兼容。

类别

数组（字符串）

类别是此自定义资源所属的分组资源列表（如 'all'）。这在 API 发现文档中发布，供客户端用于支持诸如 kubectl get 所有的调用。

kind

字符串

kind 是资源的序列化类型。它通常是 CamelCase 和 singular。自定义资源实例将使用这个值作为 API 调用中的 kind 属性。

listKind

字符串

listKind 是此资源列表的序列化类型。默认为 "'kind'List"。

plural

字符串

plural 是要服务的资源的复数名称。自定义资源在 /apis//&lt ;version>/…​/<plural> 下提供。必须与 CustomResourceDefinition 的名称匹配（格式为 <names.plural>.）。必须都是小写。

shortNames

数组（字符串）

shortNames 是资源的短名称，在 API 发现文档中公开，供客户端用来支持诸如 kubectl get <shortname> 等调用。它必须都是小写。

singular

字符串

单数是资源的单数名称。它必须都是小写。默认为小写 类型。

additionalPrinterColumns

array

additionalPrinterColumns 指定表输出中返回的额外列。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables。如果没有指定列，则使用一行显示自定义资源的年龄。

additionalPrinterColumns[]

对象

CustomResourceColumnDefinition 为服务器端打印指定一个列。

已弃用

布尔值

弃用表示自定义资源 API 的这个版本已弃用。当设置为 true 时，对此版本的 API 请求会在服务器响应中接收警告标头。默认为false。

deprecationWarning

字符串

deprecationWarning 覆盖返回到 API 客户端的默认警告。只有在 已弃用 为 true 时才能设置。默认警告表示这个版本已弃用，建议使用最新的服务版本等于或更高稳定性（如果存在）。

name

字符串

name 是版本名称，如 "v1", "v2beta1" 等。如果提供为 true，则自定义资源在此版本 /apis//<version&gt ;/ …​ 下提供。

schema

对象

CustomResourceValidation 是 CustomResources 的验证方法列表。

served

布尔值

服务是一个标志，启用/禁用此版本通过 REST API 提供

storage

布尔值

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

subresources

对象

CustomResourceSubresources 为 CustomResources 定义 status 和 scale 子资源。

description

字符串

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

格式

字符串

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

jsonPath

字符串

jsonpath 是一个一个简单的 JSON 路径（例如，使用数组表示法），它会针对每个自定义资源进行评估，以便为此列生成值。

name

字符串

name 是该列的人类可读名称。

priority

整数

优先级是一个整数，定义此列的相对重要性，与其他列相比。较低数字被视为优先级更高。在有限空间场景中可能会省略的列应赋予优先级大于 0。

type

字符串

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

openAPIV3Schema

JSONSchemaProps

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

scale

对象

CustomResourceSubresourceScale 定义如何为 CustomResource 提供 scale 子资源。

status

对象

CustomResourceSubresourceStatus 定义如何为 CustomResources 提供 status 子资源。状态由 CustomResource 中的 .status JSON 路径表示。设置后，Ceph 会公开自定义资源 * PUT 请求到 /status 子资源的 /status 子资源获取自定义资源对象，并忽略除 status 小节之外的任何状态片段更改的 /status 子资源忽略对 status 小节的更改。

labelSelectorPath

字符串

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

specReplicasPath

字符串

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

statusReplicasPath

字符串

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

acceptedNames

对象

CustomResourceDefinitionNames 表示为这个 CustomResourceDefinition 提供的名称

conditions

array

conditions 表示 CustomResourceDefinition 的特定方面的状态

conditions[]

对象

CustomResourceDefinitionCondition 包含此 pod 的当前条件的详情。

storedVersions

数组（字符串）

storedVersions 列出之前保留的所有 CustomResource 版本。跟踪这些版本允许 etcd 中保存版本的迁移路径。该字段是可变的，因此迁移控制器可以完成到另一个版本的迁移（确保存储中没有保留旧对象），然后从此列表中删除其余版本。在此列表中存在时，可能无法从 spec.versions 中删除版本。

类别

数组（字符串）

类别是此自定义资源所属的分组资源列表（如 'all'）。这在 API 发现文档中发布，供客户端用于支持诸如 kubectl get 所有的调用。

kind

字符串

kind 是资源的序列化类型。它通常是 CamelCase 和 singular。自定义资源实例将使用这个值作为 API 调用中的 kind 属性。

listKind

字符串

listKind 是此资源列表的序列化类型。默认为 "'kind'List"。

plural

字符串

plural 是要服务的资源的复数名称。自定义资源在 /apis//&lt ;version>/…​/<plural> 下提供。必须与 CustomResourceDefinition 的名称匹配（格式为 <names.plural>.）。必须都是小写。

shortNames

数组（字符串）

shortNames 是资源的短名称，在 API 发现文档中公开，供客户端用来支持诸如 kubectl get <shortname> 等调用。它必须都是小写。

singular

字符串

单数是资源的单数名称。它必须都是小写。默认为小写 类型。

lastTransitionTime

时间

lastTransitionTime 时间，条件从一个状态转换到另一个状态。

message

字符串

Message 是人类可读的消息，表示有关最后一次转换的详细信息。

reason

字符串

reason 是条件最后一次转换的唯一一词 CamelCase 原因。

status

字符串

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

type

字符串

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

pretty

字符串

如果为 'true'，则输出会经过 pretty print 处理。

继续

字符串

从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。

当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。

dryRun

字符串

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

fieldSelector

字符串

一个选择器，用于限制其字段返回的对象列表。默认为任何内容。

gracePeriodSeconds

整数

应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。

labelSelector

字符串

一个选择器，用于限制其标签返回的对象列表。默认为任何内容。

limit

整数

limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的"continue"字段设为可用于同一初始查询的值，以检索下一组结果。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。

服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。

orphanDependents

布尔值

弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。

propagationPolicy

字符串

是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。

resourceVersion

字符串

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

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。

默认为未设置

sendInitialEvents

布尔值

'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，观察流将以复合事件开头，以生成集合中对象的当前状态。发送完所有这些事件后，将发送合成"Bookmark"事件。书签将报告与对象集合对应的 ResourceVersion (RV)，并使用 '"k8s.io/initial-events-end": "true" 注解进行标记。之后，监视流将照常进行，从而向监视的对象发送与更改对应的监视事件（按 RV 排序）。

当设置 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。watch 请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 被解释为"data"作为提供的 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签 事件至少作为 ListOptions 提供的 "resourceVersion'。如果未设置 'resourceVersion'，这会被解释为 "consistent read"，当请求开始处理时至少会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或未设置 Invalid 错误。

如果 'resourceVersion=""' 或 'resourceVersion="0"' （出于向后兼容原因）和 false，则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。

正文（body）

DeleteOptions 模式

200 - OK

Status 模式

401 - Unauthorized

空

allowWatchBookmarks

布尔值

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

继续

字符串

从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。

当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。

fieldSelector

字符串

一个选择器，用于限制其字段返回的对象列表。默认为任何内容。

labelSelector

字符串

一个选择器，用于限制其标签返回的对象列表。默认为任何内容。

limit

整数

limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的"continue"字段设为可用于同一初始查询的值，以检索下一组结果。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。

服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。

resourceVersion

字符串

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

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。

默认为未设置

sendInitialEvents

布尔值

'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，观察流将以复合事件开头，以生成集合中对象的当前状态。发送完所有这些事件后，将发送合成"Bookmark"事件。书签将报告与对象集合对应的 ResourceVersion (RV)，并使用 '"k8s.io/initial-events-end": "true" 注解进行标记。之后，监视流将照常进行，从而向监视的对象发送与更改对应的监视事件（按 RV 排序）。

当设置 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。watch 请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 被解释为"data"作为提供的 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签 事件至少作为 ListOptions 提供的 "resourceVersion'。如果未设置 'resourceVersion'，这会被解释为 "consistent read"，当请求开始处理时至少会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或未设置 Invalid 错误。

如果 'resourceVersion=""' 或 'resourceVersion="0"' （出于向后兼容原因）和 false，则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。

watch

布尔值

观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

200 - OK

CustomResourceDefinitionList 模式

401 - Unauthorized

空

dryRun

字符串

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

fieldManager

字符串

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

fieldValidation

string

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

正文（body）

CustomResourceDefinition 模式

200 - OK

CustomResourceDefinition 模式

201 - Created

CustomResourceDefinition 模式

202 - Accepted

CustomResourceDefinition 模式

401 - Unauthorized

空

allowWatchBookmarks

布尔值

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

继续

字符串

从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。

当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。

fieldSelector

字符串

一个选择器，用于限制其字段返回的对象列表。默认为任何内容。

labelSelector

字符串

一个选择器，用于限制其标签返回的对象列表。默认为任何内容。

limit

整数

limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的"continue"字段设为可用于同一初始查询的值，以检索下一组结果。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。

服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。

pretty

字符串

如果为 'true'，则输出会经过 pretty print 处理。

resourceVersion

字符串

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

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。

默认为未设置

sendInitialEvents

布尔值

'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，观察流将以复合事件开头，以生成集合中对象的当前状态。发送完所有这些事件后，将发送合成"Bookmark"事件。书签将报告与对象集合对应的 ResourceVersion (RV)，并使用 '"k8s.io/initial-events-end": "true" 注解进行标记。之后，监视流将照常进行，从而向监视的对象发送与更改对应的监视事件（按 RV 排序）。

当设置 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。watch 请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 被解释为"data"作为提供的 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签 事件至少作为 ListOptions 提供的 "resourceVersion'。如果未设置 'resourceVersion'，这会被解释为 "consistent read"，当请求开始处理时至少会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或未设置 Invalid 错误。

如果 'resourceVersion=""' 或 'resourceVersion="0"' （出于向后兼容原因）和 false，则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。

watch

布尔值

观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

200 - OK

WatchEvent 模式

401 - Unauthorized

空

name

字符串

CustomResourceDefinition 的名称

pretty

字符串

如果为 'true'，则输出会经过 pretty print 处理。

dryRun

字符串

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

gracePeriodSeconds

整数

应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。

orphanDependents

布尔值

弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。

propagationPolicy

字符串

是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。

正文（body）

DeleteOptions 模式

200 - OK

Status 模式

202 - Accepted

Status 模式

401 - Unauthorized

空

200 - OK

CustomResourceDefinition 模式

401 - Unauthorized

空

dryRun

字符串

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

fieldManager

字符串

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

fieldValidation

string

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

force

布尔值

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

正文（body）

Patch 模式

200 - OK

CustomResourceDefinition 模式

201 - Created

CustomResourceDefinition 模式

401 - Unauthorized

空

dryRun

字符串

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

fieldManager

字符串

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

fieldValidation

string

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

正文（body）

CustomResourceDefinition 模式

200 - OK

CustomResourceDefinition 模式

201 - Created

CustomResourceDefinition 模式

401 - Unauthorized

空

name

字符串

CustomResourceDefinition 的名称

allowWatchBookmarks

布尔值

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

继续

字符串

从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。

当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。

fieldSelector

字符串

一个选择器，用于限制其字段返回的对象列表。默认为任何内容。

labelSelector

字符串

一个选择器，用于限制其标签返回的对象列表。默认为任何内容。

limit

整数

limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的"continue"字段设为可用于同一初始查询的值，以检索下一组结果。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。

服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。

pretty

字符串

如果为 'true'，则输出会经过 pretty print 处理。

resourceVersion

字符串

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

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。

默认为未设置

sendInitialEvents

布尔值

'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，观察流将以复合事件开头，以生成集合中对象的当前状态。发送完所有这些事件后，将发送合成"Bookmark"事件。书签将报告与对象集合对应的 ResourceVersion (RV)，并使用 '"k8s.io/initial-events-end": "true" 注解进行标记。之后，监视流将照常进行，从而向监视的对象发送与更改对应的监视事件（按 RV 排序）。

当设置 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。watch 请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 被解释为"data"作为提供的 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签 事件至少作为 ListOptions 提供的 "resourceVersion'。如果未设置 'resourceVersion'，这会被解释为 "consistent read"，当请求开始处理时至少会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或未设置 Invalid 错误。

如果 'resourceVersion=""' 或 'resourceVersion="0"' （出于向后兼容原因）和 false，则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。

watch

布尔值

观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

200 - OK

WatchEvent 模式

401 - Unauthorized

空

name

字符串

CustomResourceDefinition 的名称

pretty

字符串

如果为 'true'，则输出会经过 pretty print 处理。

200 - OK

CustomResourceDefinition 模式

401 - Unauthorized

空

dryRun

字符串

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

fieldManager

字符串

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

fieldValidation

string

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

force

布尔值

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

正文（body）

Patch 模式

200 - OK

CustomResourceDefinition 模式

201 - Created

CustomResourceDefinition 模式

401 - Unauthorized

空

dryRun

字符串

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

fieldManager

字符串

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

fieldValidation

string

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

正文（body）

CustomResourceDefinition 模式

200 - OK

CustomResourceDefinition 模式

201 - Created

CustomResourceDefinition 模式

401 - Unauthorized

空