通用参数
allowWatchBookmarks
allowWatchBookmarks 请求带有类型“BOOKMARK”的 watch 事件。不支持书签的服务器可能会忽略此标志,并且书签将根据服务器的决定发送。客户端不应假设书签会在任何特定间隔返回,也不应假设服务器会在会话期间发送任何 BOOKMARK 事件。如果这不是 watch,则会忽略此字段。
继续
从服务器检索更多结果时,应设置继续选项。由于此值由服务器定义,因此客户端只能使用先前查询结果中具有相同查询参数(除继续的值外)的继续值,并且服务器可能会拒绝它不识别的继续值。如果指定的继续值不再有效(无论是由于过期(通常为五到十五分钟)还是服务器上的配置更改),服务器将响应 410 ResourceExpired 错误以及继续令牌。如果客户端需要一致的列表,则必须在不使用 continue 字段的情况下重新启动其列表。否则,客户端可以发送另一个带有所收到的 410 错误令牌的列表请求,服务器将响应从下一个键开始的列表,但来自最新快照,这与先前的列表结果不一致 - 在第一个列表请求之后创建、修改或删除的对象将包括在响应中,只要它们的键在“下一个键”之后。
当 watch 为真时,此字段不受支持。客户端可以从服务器返回的最后一个 resourceVersion 值开始 watch,并且不会错过任何修改。
dryRun
如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- 全部:将处理所有 dry run 阶段
fieldManager
fieldManager 是与执行这些更改的参与者或实体相关的名称。该值必须小于或等于 128 个字符,并且只包含可打印字符,如 https://pkg.go.dev/unicode#IsPrint 所定义。
fieldSelector
选择器用于通过其字段限制返回的对象列表。默认为所有内容。
fieldValidation
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象。有效值为:- 忽略:这将忽略从对象中静默删除的任何未知字段,并将忽略解码器遇到的最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为。- 警告:这将通过标准警告响应标头为从对象中删除的每个未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍将成功,并且只会持久化任何重复字段的最后一个。这是 v1.23+ 中的默认设置 - 严格:如果从对象中删除任何未知字段,或者存在任何重复字段,这将导致请求失败并出现 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
强制
Force 将“强制”应用请求。这意味着用户将重新获取与其他人拥有的冲突字段。对于非应用补丁请求,必须取消设置 Force 标志。
gracePeriodSeconds
对象应在删除之前等待的持续时间(秒)。值必须是非负整数。值零表示立即删除。如果此值为 nil,则将使用指定类型的默认宽限期。如果未指定,则默认为每个对象的值。零表示立即删除。
labelSelector
选择器用于通过其标签限制返回的对象列表。默认为所有内容。
限制
limit 是列表调用返回的响应的最大数量。如果存在更多项,服务器将设置列表元数据上的 continue
字段,其值为可以使用相同初始查询检索下一组结果的值。在所有请求的对象都被过滤掉的情况下,设置限制可能会返回少于请求数量的项(最多为零项),并且客户端应仅使用 continue 字段的存在来确定是否还有更多结果可用。服务器可以选择不支持 limit 参数,并将返回所有可用结果。如果指定了 limit 并且 continue 字段为空,则客户端可以假设没有更多结果可用。如果 watch 为真,则此字段不受支持。
服务器保证,使用 continue 返回的对象将与发出不带 limit 的单个列表调用相同,即,在发出第一个请求后创建、修改或删除的对象将不会包含在任何后续的继续请求中。这有时被称为一致快照,并确保使用 limit 接收非常大结果的小块数据的客户端可以确保他们看到所有可能的物体。如果在分块列表期间更新了对象,则将返回在计算第一个列表结果时存在于对象中的版本。
命名空间
对象名称和身份验证范围,例如团队和项目。
漂亮
如果为“true”,则输出将被美化打印。
propagationPolicy
是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents,但不能同时设置两者。默认策略由元数据中存在的 finalizer 设置以及特定于资源的默认策略决定。可接受的值为:“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
一起设置。在这种情况下,watch 流将从合成事件开始,以生成集合中对象的当前状态。一旦所有此类事件都被发送,就会发送一个合成“书签”事件。书签将报告与对象集相对应的 ResourceVersion (RV),并标记为 "k8s.io/initial-events-end": "true"
注释。之后,watch 流将照常进行,发送与监视的对象的更改(后续于 RV)相对应的 watch 事件。
当设置 sendInitialEvents
选项时,我们要求 resourceVersionMatch
选项也设置。watch 请求的语义如下:- resourceVersionMatch
= NotOlderThan 被解释为“数据至少与提供的 resourceVersion
一样新”,并且当状态同步到至少与 ListOptions 提供的版本一样新的 resourceVersion
时,就会发送书签事件。如果 resourceVersion
未设置,则将其解释为“一致读取”,并且当状态同步到至少与请求开始处理时的时刻一样新时,就会发送书签事件。
resourceVersionMatch
设置为任何其他值或未设置将返回 Invalid 错误。
如果 resourceVersion=""
或 resourceVersion="0"
(出于向后兼容性原因),则默认为 true,否则默认为 false。
timeoutSeconds
列表/watch 调用的超时时间。这限制了调用的持续时间,无论是否存在任何活动或非活动。
观看
监视描述的资源的更改,并将它们作为添加、更新和删除通知流返回。指定 resourceVersion。
此页面是自动生成的。
如果您打算报告此页面的问题,请在问题描述中提及此页面是自动生成的。修复可能需要在 Kubernetes 项目的其他地方进行。