CronJob v1beta1

CronJob

apiVersion: batch/v1beta1
import "k8s.io/api/batch/v1beta1"

CronJob

CronJob represents the configuration of a single cron job.

CronJobSpec

CronJobSpec describes how the job execution will look like and when it will actually run.

  • jobTemplate (JobTemplateSpec), required
    Specifies the job that will be created when executing a CronJob.
    JobTemplateSpec describes the data a Job should have when created from a template
  • schedule (string), required
    The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
  • concurrencyPolicy (string)
    Specifies how to treat concurrent executions of a Job. Valid values are: - “Allow” (default): allows CronJobs to run concurrently; - “Forbid”: forbids concurrent runs, skipping next run if previous run hasn’t finished yet; - “Replace”: cancels currently running job and replaces it with a new one
  • startingDeadlineSeconds (int64)
    Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.
  • suspend (boolean)
    This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.
  • successfulJobsHistoryLimit (int32)
    The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 3.
  • failedJobsHistoryLimit (int32)
    The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.

CronJobStatus

CronJobStatus represents the current state of a cron job.

  • active ([]ObjectReference)
    A list of pointers to currently running jobs.
  • lastScheduleTime (Time)
    Information when was the last time the job was successfully scheduled.
    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

CronJobList

CronJobList is a collection of cron jobs.

Operations

get read the specified CronJob

HTTP Request

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

Parameters
  • {name} (string), required
    name of the CronJob
  • {namespace} (string), required
    namespace
  • ?pretty (string)
    pretty
Response

200 (CronJob): OK
401: Unauthorized

get read status of the specified CronJob

HTTP Request

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

Parameters
  • {name} (string), required
    name of the CronJob
  • {namespace} (string), required
    namespace
  • ?pretty (string)
    pretty
Response

200 (CronJob): OK
401: Unauthorized

list list or watch objects of kind CronJob

HTTP Request

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

Parameters
Response

200 (CronJobList): OK
401: Unauthorized

list list or watch objects of kind CronJob

HTTP Request

GET /apis/batch/v1beta1/cronjobs

Parameters
Response

200 (CronJobList): OK
401: Unauthorized

create create a CronJob

HTTP Request

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

Parameters
Response

200 (CronJob): OK
201 (CronJob): Created
202 (CronJob): Accepted
401: Unauthorized

update replace the specified CronJob

HTTP Request

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

Parameters
Response

200 (CronJob): OK
201 (CronJob): Created
401: Unauthorized

update replace status of the specified CronJob

HTTP Request

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

Parameters
Response

200 (CronJob): OK
201 (CronJob): Created
401: Unauthorized

patch partially update the specified CronJob

HTTP Request

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

Parameters
  • {name} (string), required
    name of the CronJob

  • {namespace} (string), required
    namespace

  • body (Patch), required

  • ?dryRun (string)
    dryRun

  • ?fieldManager (string)
    fieldManager

  • ?force (boolean)
    force

  • ?pretty (string)
    pretty

Response

200 (CronJob): OK
401: Unauthorized

patch partially update status of the specified CronJob

HTTP Request

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

Parameters
  • {name} (string), required
    name of the CronJob

  • {namespace} (string), required
    namespace

  • body (Patch), required

  • ?dryRun (string)
    dryRun

  • ?fieldManager (string)
    fieldManager

  • ?force (boolean)
    force

  • ?pretty (string)
    pretty

Response

200 (CronJob): OK
401: Unauthorized

delete delete a CronJob

HTTP Request

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

Parameters
Response

200 (Status): OK
202 (Status): Accepted
401: Unauthorized

deletecollection delete collection of CronJob

HTTP Request

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

Parameters
Response

200 (Status): OK
401: Unauthorized