通用参数

allowWatchBookmarks

allowWatchBookmarks 请求类型为“BOOKMARK”的 watch 事件。不实现书签的服务器可能会忽略此标志,并且书签是在服务器自行决定的情况下发送的。客户端不应假定书签以任何特定间隔返回,也不应假定服务器在会话期间会发送任何 BOOKMARK 事件。如果这不是 watch,则会忽略此字段。


continue

当检索更多服务器结果时,应设置 continue 选项。由于此值是由服务器定义的,客户端只能使用先前查询结果中的 continue 值(除 continue 值本身外,查询参数相同),并且服务器可能会拒绝其不认识的 continue 值。如果指定的 continue 值不再有效(通常是因为过期(通常为五到十五分钟)或服务器上的配置更改),服务器将响应 410 ResourceExpired 错误以及一个 continue token。如果客户端需要一致的列表,则必须在没有 continue 字段的情况下重新启动列表。否则,客户端可以发送带有 410 错误提供的 token 的另一个列表请求,服务器将从下一个键开始响应列表,但从最新的快照开始,这与之前的列表结果不一致——在第一个列表请求之后创建、修改或删除的对象将被包含在响应中,只要它们的键在“下一个键”之后。

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


dryRun

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


fieldManager

fieldManager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于 128 个字符,并且只能包含可打印字符,由 https://golang.ac.cn/pkg/unicode/#IsPrint 定义。


fieldSelector

用于通过其字段限制返回对象列表的选择器。默认为所有对象。


fieldValidation

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


force

Force 将“强制”执行 Apply 请求。这意味着用户将重新获取他人拥有的冲突字段。对于非 Apply patch 请求,必须取消设置 Force 标志。


gracePeriodSeconds

对象应被删除的秒数。值必须是非负整数。值为零表示立即删除。如果此值为 nil,将使用指定类型的默认宽限期。如果未指定,则默认为每个对象的值。零表示立即删除。


ignoreStoreReadErrorWithClusterBreakingPotential

如果设置为 true,在正常删除流程因损坏对象错误而失败的情况下,将触发资源的非安全删除。如果由于 a) 其数据无法转换(例如解密失败)或 b) 其解码为对象失败而无法成功从底层存储中检索,则认为资源已损坏。注意:非安全删除会忽略 finalizer 约束,跳过先决条件检查,并从存储中删除对象。警告:这可能会破坏集群,如果与被非安全删除的资源关联的工作负载依赖于正常的删除流程。仅在您真正知道自己在做什么时才使用。默认值为 false,并且用户必须选择启用。


labelSelector

用于通过其标签限制返回对象列表的选择器。默认为所有对象。


limit

limit 是列表调用返回的最大响应数。如果存在更多项目,服务器将在列表元数据中设置 continue 字段,其值可与相同的初始查询一起使用以检索下一组结果。设置 limit 可能会返回少于请求数量的项目(最多为零项),如果所有请求的对象都被过滤掉,并且客户端应仅使用 continue 字段的存在来确定是否还有更多结果可用。服务器可能选择不支持 limit 参数,并将返回所有可用结果。如果指定了 limit 并且 continue 字段为空,客户端可以假定没有更多可用结果。如果 watch 为 true,则不支持此字段。

服务器保证使用 continue 返回的对象将与不带 limit 的单个列表调用相同——也就是说,在第一个请求发出后创建、修改或删除的任何对象都不会包含在任何后续的继续请求中。这有时被称为一致的快照,并确保使用 limit 来接收小块结果的客户端可以看到所有可能的对象。如果在分块列表中更新了对象,将返回第一个列表结果计算时存在的对象版本。


命名空间

对象名称和身份验证范围,例如用于团队和项目


pretty

如果为“true”,则输出将是漂亮的打印格式。默认为“false”,除非 user-agent 指示浏览器或命令行 HTTP 工具(curl 和 wget)。


propagationPolicy

垃圾回收将如何执行。此字段或 OrphanDependents 可以被设置,但不能同时设置。默认策略由元数据中设置的现有 finalizer 和资源特定的默认策略决定。可接受的值为:“Orphan”——孤立依赖项;“Background”——允许垃圾回收器在后台删除依赖项;“Foreground”——级联策略,在前台删除所有依赖项。


resourceVersion

resourceVersion 设置了请求可以从哪些资源版本提供的约束。有关详细信息,请参阅 https://kubernetes.ac.cn/docs/reference/using-api/api-concepts/#resource-versions

默认为 unset


resourceVersionMatch

resourceVersionMatch 确定 resourceVersion 如何应用于列表调用。强烈建议为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。有关详细信息,请参阅 https://kubernetes.ac.cn/docs/reference/using-api/api-concepts/#resource-versions

默认为 unset


sendInitialEvents

sendInitialEvents=true 可以与 watch=true 一起设置。在这种情况下,watch 流将从合成事件开始,以生成集合中对象的当前状态。一旦所有此类事件都已发送,将发送一个合成“Bookmark”事件。书签将报告与对象集对应的 ResourceVersion (RV),并标记有 "k8s.io/initial-events-end": "true" 注释。之后,watch 流将照常进行,发送与对象更改(在 RV 之后)相对应的 watch 事件。

当设置了 sendInitialEvents 选项时,我们需要同时设置 resourceVersionMatch 选项。watch 请求的语义如下:- resourceVersionMatch = NotOlderThan 被解释为“数据至少与提供的 resourceVersion 一样新”,并且在状态同步到至少与 ListOptions 提供的 resourceVersion 一样新的 resourceVersion 时发送书签事件。如果 resourceVersion 未设置,则将其解释为“一致性读取”,并在状态同步到请求开始处理的时刻或之后发送书签事件。

  • resourceVersionMatch 设置为任何其他值或未设置时,将返回 Invalid 错误。

如果 resourceVersion=""resourceVersion="0"(出于向后兼容性原因),则默认为 true,否则默认为 false。


timeoutSeconds

列表/watch 调用的超时时间。这限制了调用的持续时间,而不管任何活动或不活动。


watch

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


本页面是自动生成的。

如果你打算报告此页面存在的问题,请在问题描述中提及此页面是自动生成的。修复可能需要在 Kubernetes 项目的其他地方进行。

上次修改时间:2025 年 9 月 4 日 下午 3:37 PST:更新 v1.34 的 API 资源参考 (3e10e8c195)