CronJob

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

apiVersion: batch/v1

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

CronJob

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


CronJobSpec

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


  • jobTemplate (JobTemplateSpec),必需

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

    JobTemplateSpec 描述了从模板创建的 Job 应该拥有的数据

  • schedule (string),必需

    Cron 格式的计划,请参阅 https://en.wikipedia.org/wiki/Cron

  • timeZone (string)

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

  • concurrencyPolicy (string)

    指定如何处理 Job 的并发执行。有效值是

    • “Allow”(默认):允许 CronJob 并发运行;- “Forbid”:禁止并发运行,如果先前的运行尚未完成,则跳过下一次运行;- “Replace”:取消当前正在运行的作业,并用新的作业替换它
  • startingDeadlineSeconds (int64)

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

  • suspend (boolean)

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

  • successfulJobsHistoryLimit (int32)

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

  • failedJobsHistoryLimit (int32)

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

CronJobStatus

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


  • active ([]ObjectReference)

    原子性:将在合并期间被替换

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

  • lastScheduleTime (Time)

    上次成功安排作业的时间信息。

    Time 是 time.Time 的包装器,它支持正确地编排为 YAML 和 JSON。为 time 包提供的许多工厂方法提供了包装器。

  • lastSuccessfulTime (Time)

    上次作业成功完成的时间信息。

    Time 是 time.Time 的包装器,它支持正确地编排为 YAML 和 JSON。为 time 包提供的许多工厂方法提供了包装器。

CronJobList

CronJobList 是 cron 作业的集合。


操作


get 读取指定的 CronJob

HTTP 请求

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

参数

  • name (在路径中):string,必需

    CronJob 的名称

  • namespace (在路径中):string,必需

    命名空间

  • pretty (在查询中):string

    pretty

响应

200 (CronJob): OK

401: 未授权

get 读取指定的 CronJob 的状态

HTTP 请求

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

参数

  • name (在路径中):string,必需

    CronJob 的名称

  • namespace (在路径中):string,必需

    命名空间

  • pretty (在查询中):string

    pretty

响应

200 (CronJob): OK

401: 未授权

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

HTTP 请求

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

参数

响应

200 (CronJobList): OK

401: 未授权

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

HTTP 请求

GET /apis/batch/v1/cronjobs

参数

响应

200 (CronJobList): OK

401: 未授权

create 创建一个 CronJob

HTTP 请求

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

参数

响应

200 (CronJob): OK

201 (CronJob): 已创建

202 (CronJob): 已接受

401: 未授权

update 替换指定的 CronJob

HTTP 请求

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

参数

  • name (在路径中):string,必需

    CronJob 的名称

  • namespace (在路径中):string,必需

    命名空间

  • body: CronJob,必需

  • dryRun (在查询中):string

    dryRun

  • fieldManager (在查询中):string

    fieldManager

  • fieldValidation (在查询中):string

    fieldValidation

  • pretty (在查询中):string

    pretty

响应

200 (CronJob): OK

201 (CronJob): 已创建

401: 未授权

update 替换指定的 CronJob 的状态

HTTP 请求

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

参数

  • name (在路径中):string,必需

    CronJob 的名称

  • namespace (在路径中):string,必需

    命名空间

  • body: CronJob,必需

  • dryRun (在查询中):string

    dryRun

  • fieldManager (在查询中):string

    fieldManager

  • fieldValidation (在查询中):string

    fieldValidation

  • pretty (在查询中):string

    pretty

响应

200 (CronJob): OK

201 (CronJob): 已创建

401: 未授权

patch 部分更新指定的 CronJob

HTTP 请求

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

参数

  • name (在路径中):string,必需

    CronJob 的名称

  • namespace (在路径中):string,必需

    命名空间

  • body: Patch,必需

  • dryRun (在查询中):string

    dryRun

  • fieldManager (在查询中):string

    fieldManager

  • fieldValidation (在查询中):string

    fieldValidation

  • force (在查询中):boolean

    force

  • pretty (在查询中):string

    pretty

响应

200 (CronJob): OK

201 (CronJob): 已创建

401: 未授权

patch 部分更新指定 CronJob 的状态

HTTP 请求

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

参数

  • name (在路径中):string,必需

    CronJob 的名称

  • namespace (在路径中):string,必需

    命名空间

  • body: Patch,必需

  • dryRun (在查询中):string

    dryRun

  • fieldManager (在查询中):string

    fieldManager

  • fieldValidation (在查询中):string

    fieldValidation

  • force (在查询中):boolean

    force

  • pretty (在查询中):string

    pretty

响应

200 (CronJob): OK

201 (CronJob): 已创建

401: 未授权

delete 删除一个 CronJob

HTTP 请求

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

参数

响应

200 (Status): OK

202 (Status): 已接受

401: 未授权

deletecollection 删除 CronJob 的集合

HTTP 请求

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

参数

响应

200 (Status): OK

401: 未授权

此页面是自动生成的。

如果您计划报告此页面的问题,请在您的问题描述中说明该页面是自动生成的。修复可能需要在 Kubernetes 项目的其他地方进行。

上次修改时间为太平洋标准时间 2024 年 8 月 28 日下午 6:01:更新 v1.31 生成的 API 参考 (8ba98c79c1)