通用参数
allowWatchBookmarks
allowWatchBookmarks 请求带有类型为 "BOOKMARK" 的 watch 事件。不实现书签的服务器可能会忽略此标志,并且书签会由服务器自行决定发送。客户端不应假定在任何特定间隔发送书签,也不应假定服务器会在会话期间发送任何 BOOKMARK 事件。如果这不是 watch,则此字段将被忽略。
continue
继续选项应在从服务器检索更多结果时设置。由于此值由服务器定义,客户端只能将来自先前查询结果的继续值与相同的查询参数(continue 值除外)一起使用,并且服务器可能会拒绝其不识别的继续值。如果指定的继续值由于过期(通常为五到十五分钟)或服务器上的配置更改而不再有效,服务器将使用 410 ResourceExpired 错误以及一个继续令牌进行响应。如果客户端需要一致的列表,则必须在不使用 continue 字段的情况下重新启动其列表。否则,客户端可以发送带有从 410 错误收到的令牌的另一个列表请求,服务器将从下一个键开始响应列表,但来自最新的快照,与之前的列表结果不一致 - 在第一个列表请求之后创建、修改或删除的对象将包含在响应中,只要它们的键在“下一个键”之后。
当 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 将“强制”应用请求。这意味着用户将重新获取其他人拥有的冲突字段。对于非应用补丁请求,必须取消设置 Force 标志。
gracePeriodSeconds
对象应被删除之前的秒数。值必须是非负整数。值为零表示立即删除。如果此值为 nil,将使用指定类型默认的宽限期。默认情况下,如果未指定,则为每个对象的值。零表示立即删除。
ignoreStoreReadErrorWithClusterBreakingPotential
如果设置为 true,则将在正常删除流程因损坏的对象错误而失败的情况下触发资源的强制删除。如果由于 a) 无法转换其数据(例如解密失败)或 b) 无法解码为对象而无法从底层存储中成功检索资源,则认为资源已损坏。注意:强制删除会忽略 finalizer 约束,跳过预条件检查,并从存储中删除对象。警告:如果与正在强制删除的资源关联的工作负载依赖于正常的删除流程,这可能会潜在地破坏集群。仅在您真正知道自己在做什么时使用。默认值为 false,用户必须选择加入才能启用它
labelSelector
一个选择器,用于通过其标签限制返回对象的列表。默认为所有内容。
limit
limit 是列表调用要返回的最大响应数。如果存在更多项目,服务器会将 continue 字段设置为列表元数据,该字段可以使用相同的初始查询来检索下一组结果。设置 limit 可能会返回少于请求的项目数(最多为零个项目),如果所有请求的对象都被过滤掉,客户端应仅使用 continue 字段的存在来确定是否可用更多结果。服务器可以选择不支持 limit 参数并返回所有可用结果。如果指定了 limit 并且 continue 字段为空,客户端可以假定没有更多结果可用。如果 watch 为 true,则不支持此字段。
服务器保证使用 continue 返回的对象与发出单个列表调用而不使用 limit 相同 - 也就是说,在第一个请求发出后创建、修改或删除的任何对象都不会包含在任何后续的 continue 请求中。这有时被称为一致快照,可确保使用 limit 接收较小块的非常大的结果的客户端可以确保看到所有可能的对象。如果在分块列表中更新对象,则返回在计算第一个列表结果时存在的对象的版本。
命名空间
对象名称和授权范围,例如用于团队和项目
pretty
如果为 'true',则输出将进行美化打印。默认值为 'false',除非用户代理指示浏览器或命令行 HTTP 工具(curl 和 wget)。
propagationPolicy
垃圾回收将如何执行。此字段或 OrphanDependents 只能设置一个,而不能同时设置。默认策略由 metadata.finalizers 中设置的现有 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 流将像往常一样继续,发送 watch 事件,这些事件对应于被监视对象的更改(在 RV 之后)。
当设置 sendInitialEvents 选项时,我们还需要设置 resourceVersionMatch 选项。watch 请求的语义如下:- resourceVersionMatch = NotOlderThan 被解释为“数据至少与提供的 resourceVersion 一样新”,并且当状态同步到至少与提供的 resourceVersion 一样新的版本时,会发送书签事件。如果 resourceVersion 未设置,则将其解释为“一致读取”,并且当状态同步到请求开始处理的时刻时,会发送书签事件。
resourceVersionMatch设置为任何其他值或未设置,将返回 Invalid 错误。
如果 resourceVersion="" 或 resourceVersion="0"(为了向后兼容的原因),则默认为 true,否则默认为 false。
timeoutSeconds
列表/watch 调用的超时时间。这将限制调用的持续时间,而不管任何活动或非活动情况如何。
watch
监视描述资源的更改,并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。
本页面是自动生成的。
如果您打算报告此页面的问题,请在您的问题描述中提及该页面是自动生成的。修复可能需要在 Kubernetes 项目的其他地方进行。