通用参数
allowWatchBookmarks
allowWatchBookmarks 请求类型为 "BOOKMARK" 的 watch 事件。未实现书签的服务器可能会忽略此标志,书签由服务器自行决定发送。客户端不应假设书签会在任何特定间隔返回,也不应假设服务器会在会话期间发送任何 BOOKMARK 事件。如果这不是 watch 请求,则忽略此字段。
continue
当从服务器检索更多结果时,应设置 continue 选项。由于此值由服务器定义,客户端只能使用来自先前具有相同查询参数(除了 continue 的值)的查询结果的 continue 值,并且服务器可能会拒绝它无法识别的 continue 值。如果指定的 continue 值由于过期(通常为 5 到 15 分钟)或服务器上的配置更改而不再有效,服务器将使用 410 ResourceExpired 错误以及一个 continue 令牌进行响应。如果客户端需要一个一致的列表,它必须重新启动其列表而不使用 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 将“强制”执行 Apply 请求。这意味着用户将重新获取其他人拥有的冲突字段。对于非 apply patch 请求,必须取消设置 Force 标志。
gracePeriodSeconds
对象应在多少秒后被删除。值必须是非负整数。值零表示立即删除。如果此值为 nil,则将使用指定类型的默认宽限期。如果未指定,则默认为每个对象的值。零表示立即删除。
labelSelector
一个选择器,用于按对象的标签限制返回对象的列表。默认为全部。
limit
limit 是列表调用返回的最大响应数。如果存在更多项目,服务器将在列表元数据上将 continue
字段设置为一个值,该值可以与相同的初始查询一起使用以检索下一组结果。设置 limit 可能会返回少于请求的项目数(最多零个项目),以防所有请求的对象都被过滤掉,客户端应仅使用 continue 字段的存在来确定是否还有更多结果可用。服务器可以选择不支持 limit 参数,并将返回所有可用的结果。如果指定了 limit 并且 continue 字段为空,则客户端可以假设没有更多结果可用。如果 watch 为 true,则不支持此字段。
服务器保证在使用 continue 时返回的对象与发出没有 limit 的单个列表调用时的对象相同 - 也就是说,在发出第一个请求后创建、修改或删除的任何对象都不会包含在任何后续的 continue 请求中。这有时被称为一致的快照,并确保使用 limit 来接收大量结果的较小块的客户端可以确保他们看到所有可能的对象。如果在分块列表期间更新了对象,则返回计算第一个列表结果时存在的对象版本。
namespace
对象名称和授权范围,例如团队和项目
pretty
如果为 “true”,则输出是美化的。除非用户代理指示浏览器或命令行 HTTP 工具(curl 和 wget),否则默认为 “false”。
propagationPolicy
是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents,但不能同时设置两者。默认策略由 metadata.finalizers 中存在的现有终结器集和特定于资源的默认策略决定。可接受的值包括:'Orphan' - 孤立从属项;'Background' - 允许垃圾回收器在后台删除从属项;'Foreground' - 在前台删除所有从属项的级联策略。
resourceVersion
resourceVersion 设置可以从中提供请求的资源版本的约束。有关详细信息,请参见 https://kubernetes.top/docs/reference/using-api/api-concepts/#resource-versions。
默认为未设置
resourceVersionMatch
resourceVersionMatch 确定如何将 resourceVersion 应用于列表调用。强烈建议为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。有关详细信息,请参见 https://kubernetes.top/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
设置为任何其他值或未设置时,返回无效错误。
如果 resourceVersion=""
或 resourceVersion="0"
(出于向后兼容的原因),则默认为 true,否则为 false。
timeoutSeconds
列表/watch 调用的超时时间。这限制了调用的持续时间,无论任何活动或不活动。
watch
监视对描述资源的更改,并将其作为添加、更新和删除通知的流返回。指定 resourceVersion。
此页面是自动生成的。
如果您计划报告此页面的问题,请在您的问题描述中提及该页面是自动生成的。修复可能需要在 Kubernetes 项目的其他地方进行。