CronJob

CronJob 表示单个 cron 作业的配置。

apiVersion: batch/v1

import "k8s.io/api/batch/v1"

CronJob

CronJob 表示单个 cron 作业的配置。

CronJobSpec

CronJobSpec 描述了作业执行的方式以及实际运行的时间。

  • jobTemplate (JobTemplateSpec), 必需

    指定在执行 CronJob 时将创建的作业。

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

  • schedule (字符串), 必需

    以 Cron 格式表示的计划，请参见 https://en.wikipedia.org/wiki/Cron。

  • timeZone (字符串)

    给定计划的时区名称，请参见 https://en.wikipedia.org/wiki/List_of_tz_database_time_zones。如果未指定，则默认为 kube-controller-manager 进程的时区。有效时区名称集和时区偏移量在 CronJob 验证期间由 API 服务器从系统范围的时区数据库加载，在执行期间由控制器管理器加载。如果找不到系统范围的时区数据库，则改用捆绑的数据库版本。如果在 CronJob 的生命周期内或由于主机配置更改而导致时区名称变为无效，则控制器将停止创建新的作业，并将创建一个系统事件，其原因是 UnknownTimeZone。有关更多信息，请参见 https://kubernetes.ac.cn/docs/concepts/workloads/controllers/cron-jobs/#time-zones

  • concurrencyPolicy (字符串)

    指定如何处理作业的并发执行。有效值为

    • "Allow" (默认)：允许 CronJob 并发运行； - "Forbid"：禁止并发运行，如果前一次运行尚未完成，则跳过下次运行； - "Replace"：取消当前正在运行的作业并将其替换为新的作业

  • startingDeadlineSeconds (int64)

    如果由于任何原因错过了计划时间，则在启动作业时可选的截止时间（以秒为单位）。错过的作业执行将被计为失败的执行。

  • suspend (布尔值)

    此标志告诉控制器暂停后续执行，它不适用于已经启动的执行。默认为 false。

  • successfulJobsHistoryLimit (int32)

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

  • failedJobsHistoryLimit (int32)

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

CronJobStatus

CronJobStatus 表示 cron 作业的当前状态。

  • active ([]ObjectReference)

    原子：将在合并期间被替换

    指向当前正在运行的作业的指针列表。

  • lastScheduleTime (时间)

    作业最后一次成功计划的时间信息。

    时间是 time.Time 的包装器，支持正确地将数据编组为 YAML 和 JSON。包装器是为 time 包提供的许多工厂方法提供的。

  • lastSuccessfulTime (时间)

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

    时间是 time.Time 的包装器，支持正确地将数据编组为 YAML 和 JSON。包装器是为 time 包提供的许多工厂方法提供的。

CronJobList

CronJobList 是 cron 作业的集合。

操作

get 读取指定的 CronJob

HTTP 请求

GET /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}

参数

  • name (在路径中): 字符串, 必需

    CronJob 的名称

  • namespace (在路径中): 字符串, 必需

    命名空间

  • pretty (在查询中): 字符串

    漂亮

响应

200 (CronJob): 确定

401: 未经授权

get 读取指定 CronJob 的状态

HTTP 请求

GET /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status

参数

  • name (在路径中): 字符串, 必需

    CronJob 的名称

  • namespace (在路径中): 字符串, 必需

    命名空间

  • pretty (在查询中): 字符串

    漂亮

响应

200 (CronJob): 确定

401: 未经授权

list 列出或监视 CronJob 类型的对象

HTTP 请求

GET /apis/batch/v1/namespaces/{namespace}/cronjobs

参数

响应

200 (CronJobList): 确定

401: 未经授权

list 列出或监视 CronJob 类型的对象

HTTP 请求

GET /apis/batch/v1/cronjobs

参数

响应

200 (CronJobList): 确定

401: 未经授权

create 创建 CronJob

HTTP 请求

POST /apis/batch/v1/namespaces/{namespace}/cronjobs

参数

响应

200 (CronJob): 确定

201 (CronJob): 已创建

202 (CronJob): 已接受

401: 未经授权

update 替换指定的 CronJob

HTTP 请求

PUT /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}

参数

  • name (在路径中): 字符串, 必需

    CronJob 的名称

  • namespace (在路径中): 字符串, 必需

    命名空间

  • body: CronJob, 必需

  • dryRun (在查询中): 字符串

    dryRun

  • fieldManager (在查询中): 字符串

    fieldManager

  • fieldValidation (在查询中): 字符串

    fieldValidation

  • pretty (在查询中): 字符串

    漂亮

响应

200 (CronJob): 确定

201 (CronJob): 已创建

401: 未经授权

update 替换指定 CronJob 的状态

HTTP 请求

PUT /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status

参数

  • name (在路径中): 字符串, 必需

    CronJob 的名称

  • namespace (在路径中): 字符串, 必需

    命名空间

  • body: CronJob, 必需

  • dryRun (在查询中): 字符串

    dryRun

  • fieldManager (在查询中): 字符串

    fieldManager

  • fieldValidation (在查询中): 字符串

    fieldValidation

  • pretty (在查询中): 字符串

    漂亮

响应

200 (CronJob): 确定

201 (CronJob): 已创建

401: 未经授权

patch 部分更新指定的 CronJob

HTTP 请求

PATCH /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}

参数

  • name (在路径中): 字符串, 必需

    CronJob 的名称

  • namespace (在路径中): 字符串, 必需

    命名空间

  • body: Patch, 必需

  • dryRun (在查询中): 字符串

    dryRun

  • fieldManager (在查询中): 字符串

    fieldManager

  • fieldValidation (在查询中): 字符串

    fieldValidation

  • force (在查询中): 布尔值

    force

  • pretty (在查询中): 字符串

    漂亮

响应

200 (CronJob): 确定

201 (CronJob): 已创建

401: 未经授权

patch 部分更新指定 CronJob 的状态

HTTP 请求

PATCH /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status

参数

  • name (在路径中): 字符串, 必需

    CronJob 的名称

  • namespace (在路径中): 字符串, 必需

    命名空间

  • body: Patch, 必需

  • dryRun (在查询中): 字符串

    dryRun

  • fieldManager (在查询中): 字符串

    fieldManager

  • fieldValidation (在查询中): 字符串

    fieldValidation

  • force (在查询中): 布尔值

    force

  • pretty (在查询中): 字符串

    漂亮

响应

200 (CronJob): 确定

201 (CronJob): 已创建

401: 未经授权

delete 删除 CronJob

HTTP 请求

DELETE /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}

参数

响应

200 (Status): 确定

202 (Status): 已接受

401: 未经授权

deletecollection 删除 CronJob 集合

HTTP 请求

DELETE /apis/batch/v1/namespaces/{namespace}/cronjobs

参数

响应

200 (Status): 确定

401: 未经授权

此页面是自动生成的。

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

上次修改时间：2023 年 4 月 3 日上午 8:22 PST：API Ref 多页面 v1.27 (7b39e9a9ec)