通用参数

allowWatchBookmarks

allowWatchBookmarks 请求类型为 "BOOKMARK" 的监视(watch)事件。不实现书签功能的服务器可能会忽略此标志,书签将由服务器自行决定发送。客户端不应假定书签会以任何特定间隔返回,也不应假定服务器会在会话期间发送任何 BOOKMARK 事件。如果这不是监视请求,则忽略此字段。


continue

当从服务器检索更多结果时,应设置 continue 选项。由于该值由服务器定义,客户端只能使用来自先前查询结果(除 continue 值外,查询参数完全相同)的 continue 值,服务器可能会拒绝它无法识别的 continue 值。如果指定的 continue 值不再有效(无论是由于过期,通常为 5 到 15 分钟,还是由于服务器上的配置更改),服务器将响应 410 ResourceExpired 错误以及一个 continue 令牌。如果客户端需要一致的列表,则必须在没有 continue 字段的情况下重新开始列表请求。否则,客户端可以发送带有 410 错误中收到的令牌的另一个列表请求,服务器将响应一个从下一个键开始的列表,但该列表基于最新快照,这与之前的列表结果不一致——在第一次列表请求之后创建、修改或删除的对象将被包含在响应中,只要它们的键在“下一个键”之后即可。

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


dryRun

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


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 的补丁请求,必须取消设置 Force 标志。


gracePeriodSeconds

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


ignoreStoreReadErrorWithClusterBreakingPotential

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


labelSelector

用于根据标签限制返回对象列表的选择器。默认为所有内容。


limit

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

服务器保证使用 continue 时返回的对象将与在没有限制的情况下进行单次列表调用所返回的对象相同——也就是说,第一次请求发出后创建、修改或删除的对象不会包含在任何随后的继续请求中。这有时被称为一致的快照,并确保使用 limit 接收超大结果集的较小块的客户端可以确保看到所有可能的对象。如果对象在分块列表期间被更新,则返回计算第一次列表结果时对象所处版本的版本。


命名空间

对象名称和授权范围,例如用于团队和项目。


pretty

如果为 'true',则输出将被美化格式化。除非用户代理指示浏览器或命令行 HTTP 工具(curl 和 wget),否则默认为 'false'。


propagationPolicy

是否以及如何执行垃圾回收。此字段或 OrphanDependents 可以设置一个,但不能同时设置。默认策略由元数据 metadata.finalizers 中设置的现有终结器和资源特定的默认策略决定。可接受的值为:'Orphan' - 孤立依赖项;'Background' - 允许垃圾回收器在后台删除依赖项;'Foreground' - 一种级联策略,在前台删除所有依赖项。


resourceVersion

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

默认为未设置。


resourceVersionMatch

resourceVersionMatch 确定 resourceVersion 如何应用于列表调用。强烈建议为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。有关详细信息,请参阅 https://kubernetes.ac.cn/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 选项。监视请求的语义如下:- resourceVersionMatch = NotOlderThan 被解释为“至少与提供的 resourceVersion 一样新的数据”,当状态同步到至少与 ListOptions 提供的 resourceVersion 一样新的 resourceVersion 时,会发送书签事件。如果未设置 resourceVersion,则将其解释为“一致性读取”,当状态至少同步到请求开始处理的时刻时,会发送书签事件。

  • 如果 resourceVersionMatch 设置为任何其他值或未设置,则返回 Invalid 错误。

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


timeoutSeconds

列表/监视调用的超时时间。无论是否有活动或不活动,这都会限制调用的持续时间。


watch

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



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

本页面是自动生成的。

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