通用参数

allowWatchBookmarks

allowWatchBookmarks 请求类型为 "BOOKMARK" 的 watch 事件。未实现 bookmark 的服务器可以忽略此标志,并且 bookmark 会根据服务器的判断发送。客户端不应假定 bookmark 会在任何特定间隔返回,也不应假定服务器会在会话期间发送任何 BOOKMARK 事件。如果这不是一个 watch 请求,则忽略此字段。


continue

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

当 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 发出的单个列表调用返回的对象相同——也就是说,在第一个请求发出后创建、修改或删除的对象不会包含在任何后续的 continue 请求中。这有时被称为一致性快照,可确保使用 limit 获取非常大结果的小块的客户端可以看到所有可能的对象。如果在分块列表期间对象被更新,将返回在计算第一个列表结果时存在的对象版本。


namespace

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


pretty

如果为 'true',则输出将漂亮打印。默认为 'false',除非用户代理指示为浏览器或命令行 HTTP 工具(curl 和 wget)。


propagationPolicy

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


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 一起设置。在这种情况下,watch 流将以合成事件开始,以生成集合中对象的当前状态。发送完所有此类事件后,将发送一个合成的“Bookmark”事件。该 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

list/watch 调用的超时时间。这限制了调用的持续时间,而不管是否有活动或不活动。


watch

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


本页面为自动生成。

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

最后修改于 2025 年 4 月 9 日下午 6:36 PST:更新 v1.32 的 API 参考文档 (a3b579d035)