11.2. CronJob [batch/v1]

concurrencyPolicy

字符串

指定如何对待作业的并发执行。有效值为：

- "allow" （默认）：允许 CronJob 同时运行； - "Forbid": forbids 并发运行，如果上一个运行尚未完成，则跳过下一个运行；- "Replace": 取消当前运行的作业并将其替换为新作业

可能枚举值： - "Allow" 允许 CronJob 同时运行。- "Forbid" forbids 并发运行，如果之前还没有完成，则跳过下一个运行。- "Replace" 取消当前运行的作业，并将其替换为新的作业。

failedJobsHistoryLimit

整数

要保留的失败完成作业数量。值必须是非负整数。默认为 1。

jobTemplate

对象

JobTemplateSpec 描述了从模板创建时作业应具有的数据

调度

字符串

Cron 格式的调度，请参阅 https://en.wikipedia.org/wiki/Cron。

startingDeadlineSeconds

整数

如果因任何原因而错过调度时间，则启动该作业的可选期限（以秒为单位）。错过的作业执行计为失败的作业。

successfulJobsHistoryLimit

整数

要保留的成功完成作业数量。值必须是非负整数。默认值为 3。

suspend

布尔值

此标志告知控制器挂起后续执行，它不适用于已经开始的执行。默认为false。

timeZone

字符串

给定调度的时区名称，请参阅 https://en.wikipedia.org/wiki/List_of_tz_database_time_zones。如果没有指定，则默认为 kube-controller-manager 进程的时区。在 CronJob 验证和控制器管理器期间，有效时区名称和时区偏移从 API 服务器的系统范围的时区数据库加载。如果没有系统范围的时区数据库，则可以使用捆绑的数据库版本。如果时区名称在 CronJob 的生命周期内无效，或者因为主机配置中发生了变化，控制器将停止创建新作业，并创建一个原因为 UnknownTimeZone 的系统事件。如需更多信息，请参阅 https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/#time-zones

元数据

ObjectMeta

标准对象从该模板创建的作业元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

对象

JobSpec 描述了作业执行如何。

activeDeadlineSeconds

整数

指定与 startTime 相对的持续时间（以秒为单位），在系统尝试终止前可以持续激活；值必须是正整数。如果作业被暂停（创建或通过更新），在作业再次恢复时，此计时器将有效停止并重置。

backoffLimit

整数

指定在标记此作业失败前的重试次数。默认值为 6

completionMode

字符串

completionMode 指定 Pod 的完成情况。它可以是 NonIndexed （默认）或 Indexed。

NonIndexed 表示当有 .spec.completions 成功完成 Pod 时，作业被视为已完成。每个 Pod 完成都相互不同。

indexed 表示作业的 Pod 从 0 变为(.spec.completions - 1)，在注解 batch.kubernetes.io/job-completion-index 中提供。当每个索引都有一个成功完成 Pod 时，作业被视为已完成。当值被 索引时，必须指定 .spec.completions，.spec.parallelism 必须小于或等于 10^5。另外，Pod 名称的格式是 $(job-name)-$(index)-$(random-string)，Pod 主机名采用 $(job-name)-$(index) 的形式。

以后可以添加更多完成模式。如果作业控制器观察一个没有识别的模式，则在升级过程中会因为版本偏移而可能，控制器会跳过该作业的更新。

可能的值有： - "Indexed" 是一个作业完成模式。在这个模式中，作业的 Pod 从 0 变为(.spec.completions - 1)。当 Pod 完成每个完成索引时，作业被视为已完成。- "NonIndexed" 是一个作业完成模式。在这个模式中，当有 .spec.completions 成功完成 Pod 时，作业被视为已完成。Pod 完成将相互同构。

completions

整数

指定作业应使用的成功完成 pod 数量。设置为 null 表示任何 pod 的成功表示所有 pod 的成功，并允许并行具有任何正值。设置为 1 表示并行性仅限于 1，并且该 pod 的成功表示作业成功。更多信息： https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

manualSelector

布尔值

manualSelector 控制 pod 标签和 pod 选择器的生成。请保留 manualSelector 取消设置，除非您确定您要做什么。为 false 或未设置时，系统会选择此作业的唯一标签，并将这些标签附加到 pod 模板。为 true 时，用户负责选择唯一标签并指定选择器。无法选择唯一标签可能会导致这个和其他作业无法正常工作。但是，在使用旧 extensions/v1beta1 API 创建的作业中可能会看到 manualSelector=true。更多信息： https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector

parallelism

整数

指定作业应在任意给定时间运行的最大 pod 数量。当((.spec.completions - .status.successful)< .spec.parallelism)< .spec.parallelism）时，以 steady 状态运行的 pod 数量将小于这个数字。更多信息： https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

podFailurePolicy

对象

PodFailurePolicy 描述了 pod 失败的 pod 如何影响 backoffLimit。

selector

LabelSelector

对 pod 数量应该匹配的 pod 的标签查询。通常，系统会为您设置此字段。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

suspend

布尔值

suspend 指定作业控制器是否应该创建 Pod。如果创建了作业，并将 suspend 设置为 true，则作业控制器不会创建任何 Pod。如果在创建后作业被暂停（例如，标志从 false 变为 true），则作业控制器将删除与此作业关联的所有活跃 Pod。用户必须设计其工作负载才能正常处理此问题。暂停作业将重置作业的 StartTime 字段，从而有效地重置 ActiveDeadlineSeconds 计时器。默认为false。

模板

PodTemplateSpec

描述在执行作业时创建的 pod。唯一允许的 template.spec.restartPolicy 值为 "Never" 或 "OnFailure"。更多信息： https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

ttlSecondsAfterFinished

整数

ttlSecondsAfterFinished 限制已完成执行的作业的生命周期( Complete 或 Failed)。如果设置了此字段，在作业完成后，ttlSecondsAfterFinished 会被自动删除。当作业被删除时，其生命周期保证（如终结器）将会被遵守。如果此字段未设置，则作业不会被自动删除。如果此字段设为零，则作业在完成后立即被删除。

rules

array

Pod 失败策略规则列表。规则按顺序评估。当规则与 Pod 失败时，会忽略其余的规则。如果没有规则与 Pod 失败匹配，则应用默认处理 - pod 故障计数器会递增，并根据 backoffLimit 检查。最多允许 20 个元素。

rules[]

对象

PodFailurePolicyRule 描述了在满足要求时如何处理 pod 失败。每个规则都可以使用 onExitCodes 和 onPodConditions 中的一个。

action

字符串

指定在满足要求时对 pod 失败执行的操作。可能的值有：

- FailJob: 表示 pod 的作业标记为 Failed，所有正在运行的 pod 都被终止。- Ignore: 表示与 .backoffLimit 相关的计数器没有被递增，并创建了替换 pod。- Count: 表示 pod 以默认处理 - .backoffLimit 的计数器递增。以后会考虑添加其他值。客户端应通过跳过规则来响应未知操作。

possible enum value: - "Count" 是一个在 pod 失败时执行的操作 - pod 失败以默认的方式处理 - pod 失败 - 对应的 .backoffLimit 计数器，由作业的 .status.failed 字段表示。- "FailJob" is is an action, may be 在 pod 失败时 - 将 pod 的作业标记为 Failed 并终止所有正在运行的 pod。- "Ignore" 是一个在 pod 失败时执行的操作 - .backoffLimit 的计数器。 作业的 .status.failed 字段代表不会被递增，并创建了替代 pod。

onExitCodes

对象

PodFailurePolicyOnExitCodesRequirement 描述了根据容器退出代码处理失败的 pod 的要求。特别是，它会为每个应用程序容器和 init 容器状态查找 .state.terminated.exitCode，分别由 Pod 状态中的 .status.containerStatuses 和 .status.initContainerStatuses 字段表示。使用成功(exit code 0)完成的容器不包括在要求检查中。

onPodConditions

array

代表 pod 条件的要求。要求以 pod 条件模式列表表示。如果至少有一个模式匹配实际 pod 条件，则需要满足要求。最多允许 20 个元素。

onPodConditions[]

对象

PodFailurePolicyOnPodConditionsPattern 描述与实际 pod 条件类型匹配的模式。

containerName

字符串

使用指定名称将退出代码限制为容器的检查。当 null 时，该规则适用于所有容器。指定后，它应当与 pod 模板中的一个容器或 initContainer 名称匹配。

operator

字符串

表示容器退出代码和指定的值之间的关系。使用成功(exit code 0)完成的容器不包括在要求检查中。可能的值有：

- in: 如果至少有一个容器退出代码（如果多个容器没有由"containerName'字段限制）限制了多个容器，则满足要求。- 如果至少一个容器退出代码（如果多个容器不受"containerName"字段限制），则满足要求。以后会考虑添加其他值。客户端应不满足要求来响应未知操作器。

possible enum 值： - "In" - "NotIn"

值

数组（整数）

指定一组值。每个返回的容器退出代码（如果有多个容器）都会针对与 Operator 相关的这组值进行检查。值列表必须排序，且不得包含重复值。值 '0' 不能用于 In operator。至少需要一个元素。最多允许 255 个元素。

status

字符串

指定所需的 Pod 条件状态。要匹配 pod 条件，需要指定状态等于 pod 条件状态。默认值为 True。

type

字符串

指定所需的 Pod 条件类型。要匹配 pod 条件，需要指定类型等于 pod 条件类型。

active

数组(ObjectReference)

到当前运行的作业的指针列表。

lastScheduleTime

时间

当作业最后一次调度作业的时间时的信息。

lastSuccessfulTime

时间

作业最后一次完成后的信息。

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。

继续

字符串

从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。

当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。

fieldSelector

字符串

用于按字段限制返回对象列表的选择器。默认为任何内容。

labelSelector

字符串

一个选择器，用于按标签限制返回的对象列表。默认为任何内容。

limit

整数

limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。

服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。

pretty

字符串

如果 'true'，则输出会输出。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。

默认为未设置

sendInitialEvents

布尔值

'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。

当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。

如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。

watch

布尔值

观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。

200 - OK

CronJobList 模式

401 - Unauthorized

空

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。

继续

字符串

从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。

当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。

fieldSelector

字符串

用于按字段限制返回对象列表的选择器。默认为任何内容。

labelSelector

字符串

一个选择器，用于按标签限制返回的对象列表。默认为任何内容。

limit

整数

limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。

服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。

pretty

字符串

如果 'true'，则输出会输出。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。

默认为未设置

sendInitialEvents

布尔值

'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。

当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。

如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。

watch

布尔值

观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。

200 - OK

WatchEvent 模式

401 - Unauthorized

空

namespace

字符串

对象名称和身份验证范围，如团队和项目

pretty

字符串

如果 'true'，则输出会输出。

继续

字符串

从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。

当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。

dryRun

字符串

出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

fieldSelector

字符串

用于按字段限制返回对象列表的选择器。默认为任何内容。

gracePeriodSeconds

整数

应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。

labelSelector

字符串

一个选择器，用于按标签限制返回的对象列表。默认为任何内容。

limit

整数

limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。

服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。

orphanDependents

布尔值

deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。

propagationPolicy

字符串

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

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。

默认为未设置

sendInitialEvents

布尔值

'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。

当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。

如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。

正文（body）

DeleteOptions 模式

200 - OK

Status 模式

401 - Unauthorized

空

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。

继续

字符串

从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。

当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。

fieldSelector

字符串

用于按字段限制返回对象列表的选择器。默认为任何内容。

labelSelector

字符串

一个选择器，用于按标签限制返回的对象列表。默认为任何内容。

limit

整数

limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。

服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。

默认为未设置

sendInitialEvents

布尔值

'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。

当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。

如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。

watch

布尔值

观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。

200 - OK

CronJobList 模式

401 - Unauthorized

空

dryRun

字符串

出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

fieldValidation

字符串

fieldValidation 指示服务器如何处理包含未知或重复字段的请求(POST/PUT/PATCH)中的对象。有效值为： - Ignore ：这将忽略从对象静默丢弃的所有未知字段，并将忽略所有但解码器遇到的最后重复字段。这是 v1.23. - Warn: 在 v1.23 之前的默认行为：这会通过从对象丢弃的每个未知字段以及遇到的每个重复字段来发送警告。如果没有其他错误，请求仍会成功，且只保留任何重复字段的最后一个。这是 v1.23+ - Strict 的默认值：如果从对象中删除任何未知字段，或者存在任何重复字段，则会失败并显示 BadRequest 错误。从服务器返回的错误将包含遇到的所有未知和重复字段。

正文（body）

CronJob 模式

200 - OK

CronJob 模式

201 - Created

CronJob 模式

202 - Accepted

CronJob 模式

401 - Unauthorized

空

namespace

字符串

对象名称和身份验证范围，如团队和项目

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。

继续

字符串

从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。

当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。

fieldSelector

字符串

用于按字段限制返回对象列表的选择器。默认为任何内容。

labelSelector

字符串

一个选择器，用于按标签限制返回的对象列表。默认为任何内容。

limit

整数

limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。

服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。

pretty

字符串

如果 'true'，则输出会输出。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。

默认为未设置

sendInitialEvents

布尔值

'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。

当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。

如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。

watch

布尔值

观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。

200 - OK

WatchEvent 模式

401 - Unauthorized

空

name

字符串

CronJob 的名称

namespace

字符串

对象名称和身份验证范围，如团队和项目

pretty

字符串

如果 'true'，则输出会输出。

dryRun

字符串

出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

gracePeriodSeconds

整数

应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。

orphanDependents

布尔值

deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。

propagationPolicy

字符串

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

正文（body）

DeleteOptions 模式

200 - OK

Status 模式

202 - Accepted

Status 模式

401 - Unauthorized

空

200 - OK

CronJob 模式

401 - Unauthorized

空

dryRun

字符串

出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。

fieldValidation

字符串

fieldValidation 指示服务器如何处理包含未知或重复字段的请求(POST/PUT/PATCH)中的对象。有效值为： - Ignore ：这将忽略从对象静默丢弃的所有未知字段，并将忽略所有但解码器遇到的最后重复字段。这是 v1.23. - Warn: 在 v1.23 之前的默认行为：这会通过从对象丢弃的每个未知字段以及遇到的每个重复字段来发送警告。如果没有其他错误，请求仍会成功，且只保留任何重复字段的最后一个。这是 v1.23+ - Strict 的默认值：如果从对象中删除任何未知字段，或者存在任何重复字段，则会失败并显示 BadRequest 错误。从服务器返回的错误将包含遇到的所有未知和重复字段。

force

布尔值

强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。

正文（body）

Patch 模式

200 - OK

CronJob 模式

201 - Created

CronJob 模式

401 - Unauthorized

空

dryRun

字符串

出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

fieldValidation

字符串

fieldValidation 指示服务器如何处理包含未知或重复字段的请求(POST/PUT/PATCH)中的对象。有效值为： - Ignore ：这将忽略从对象静默丢弃的所有未知字段，并将忽略所有但解码器遇到的最后重复字段。这是 v1.23. - Warn: 在 v1.23 之前的默认行为：这会通过从对象丢弃的每个未知字段以及遇到的每个重复字段来发送警告。如果没有其他错误，请求仍会成功，且只保留任何重复字段的最后一个。这是 v1.23+ - Strict 的默认值：如果从对象中删除任何未知字段，或者存在任何重复字段，则会失败并显示 BadRequest 错误。从服务器返回的错误将包含遇到的所有未知和重复字段。

正文（body）

CronJob 模式

200 - OK

CronJob 模式

201 - Created

CronJob 模式

401 - Unauthorized

空

name

字符串

CronJob 的名称

namespace

字符串

对象名称和身份验证范围，如团队和项目

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。

继续

字符串

从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。

当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。

fieldSelector

字符串

用于按字段限制返回对象列表的选择器。默认为任何内容。

labelSelector

字符串

一个选择器，用于按标签限制返回的对象列表。默认为任何内容。

limit

整数

limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。

服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。

pretty

字符串

如果 'true'，则输出会输出。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。

默认为未设置

sendInitialEvents

布尔值

'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。

当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。

如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。

watch

布尔值

观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。

200 - OK

WatchEvent 模式

401 - Unauthorized

空

name

字符串

CronJob 的名称

namespace

字符串

对象名称和身份验证范围，如团队和项目

pretty

字符串

如果 'true'，则输出会输出。

200 - OK

CronJob 模式

401 - Unauthorized

空

dryRun

字符串

出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。

fieldValidation

字符串

fieldValidation 指示服务器如何处理包含未知或重复字段的请求(POST/PUT/PATCH)中的对象。有效值为： - Ignore ：这将忽略从对象静默丢弃的所有未知字段，并将忽略所有但解码器遇到的最后重复字段。这是 v1.23. - Warn: 在 v1.23 之前的默认行为：这会通过从对象丢弃的每个未知字段以及遇到的每个重复字段来发送警告。如果没有其他错误，请求仍会成功，且只保留任何重复字段的最后一个。这是 v1.23+ - Strict 的默认值：如果从对象中删除任何未知字段，或者存在任何重复字段，则会失败并显示 BadRequest 错误。从服务器返回的错误将包含遇到的所有未知和重复字段。

force

布尔值

强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。

正文（body）

Patch 模式

200 - OK

CronJob 模式

201 - Created

CronJob 模式

401 - Unauthorized

空

dryRun

字符串

出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

fieldValidation

字符串

fieldValidation 指示服务器如何处理包含未知或重复字段的请求(POST/PUT/PATCH)中的对象。有效值为： - Ignore ：这将忽略从对象静默丢弃的所有未知字段，并将忽略所有但解码器遇到的最后重复字段。这是 v1.23. - Warn: 在 v1.23 之前的默认行为：这会通过从对象丢弃的每个未知字段以及遇到的每个重复字段来发送警告。如果没有其他错误，请求仍会成功，且只保留任何重复字段的最后一个。这是 v1.23+ - Strict 的默认值：如果从对象中删除任何未知字段，或者存在任何重复字段，则会失败并显示 BadRequest 错误。从服务器返回的错误将包含遇到的所有未知和重复字段。

正文（body）

CronJob 模式

200 - OK

CronJob 模式

201 - Created

CronJob 模式

401 - Unauthorized

空