CronJob
apiVersion: batch/v2alpha1
import "k8s.io/api/batch/v2alpha1"
CronJob
CronJob represents the configuration of a single cron job.
-
apiVersion: batch/v2alpha1
-
kind: CronJob
-
metadata (ObjectMeta)
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -
spec (CronJobSpec)
Specification of the desired behavior of a cron job, including the schedule. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status -
status (CronJobStatus)
Current status of a cron job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
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- jobTemplate.metadata (ObjectMeta)
Standard object’s metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - jobTemplate.spec (JobSpec)
Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- jobTemplate.metadata (ObjectMeta)
- 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 - failedJobsHistoryLimit (int32)
The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. - 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. - successfulJobsHistoryLimit (int32)
The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. - suspend (boolean)
This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.
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.
-
apiVersion: batch/v2alpha1
-
kind: CronJobList
-
metadata (ListMeta)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -
items ([]CronJob), required
items is the list of CronJobs.
Operations
get read the specified CronJob
HTTP Request
GET /apis/batch/v2alpha1/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/v2alpha1/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/v2alpha1/namespaces/{namespace}/cronjobs
Parameters
- {namespace} (string), required
namespace - ?allowWatchBookmarks (boolean)
allowWatchBookmarks - ?continue (string)
continue - ?fieldSelector (string)
fieldSelector - ?labelSelector (string)
labelSelector - ?limit (integer)
limit - ?pretty (string)
pretty - ?resourceVersion (string)
resourceVersion - ?resourceVersionMatch (string)
resourceVersionMatch - ?timeoutSeconds (integer)
timeoutSeconds - ?watch (boolean)
watch
Response
200 (CronJobList): OK
401: Unauthorized
list list or watch objects of kind CronJob
HTTP Request
GET /apis/batch/v2alpha1/cronjobs
Parameters
- ?allowWatchBookmarks (boolean)
allowWatchBookmarks - ?continue (string)
continue - ?fieldSelector (string)
fieldSelector - ?labelSelector (string)
labelSelector - ?limit (integer)
limit - ?pretty (string)
pretty - ?resourceVersion (string)
resourceVersion - ?resourceVersionMatch (string)
resourceVersionMatch - ?timeoutSeconds (integer)
timeoutSeconds - ?watch (boolean)
watch
Response
200 (CronJobList): OK
401: Unauthorized
create create a CronJob
HTTP Request
POST /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs
Parameters
-
{namespace} (string), required
namespace -
body (CronJob), required
-
?dryRun (string)
dryRun -
?fieldManager (string)
fieldManager -
?pretty (string)
pretty
Response
200 (CronJob): OK
201 (CronJob): Created
202 (CronJob): Accepted
401: Unauthorized
update replace the specified CronJob
HTTP Request
PUT /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}
Parameters
-
{name} (string), required
name of the CronJob -
{namespace} (string), required
namespace -
body (CronJob), required
-
?dryRun (string)
dryRun -
?fieldManager (string)
fieldManager -
?pretty (string)
pretty
Response
200 (CronJob): OK
201 (CronJob): Created
401: Unauthorized
update replace status of the specified CronJob
HTTP Request
PUT /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status
Parameters
-
{name} (string), required
name of the CronJob -
{namespace} (string), required
namespace -
body (CronJob), required
-
?dryRun (string)
dryRun -
?fieldManager (string)
fieldManager -
?pretty (string)
pretty
Response
200 (CronJob): OK
201 (CronJob): Created
401: Unauthorized
patch partially update the specified CronJob
HTTP Request
PATCH /apis/batch/v2alpha1/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/v2alpha1/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/v2alpha1/namespaces/{namespace}/cronjobs/{name}
Parameters
-
{name} (string), required
name of the CronJob -
{namespace} (string), required
namespace -
body (DeleteOptions)
-
?dryRun (string)
dryRun -
?gracePeriodSeconds (integer)
gracePeriodSeconds -
?pretty (string)
pretty -
?propagationPolicy (string)
propagationPolicy
Response
200 (Status): OK
202 (Status): Accepted
401: Unauthorized
deletecollection delete collection of CronJob
HTTP Request
DELETE /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs
Parameters
-
{namespace} (string), required
namespace -
body (DeleteOptions)
-
?continue (string)
continue -
?dryRun (string)
dryRun -
?fieldSelector (string)
fieldSelector -
?gracePeriodSeconds (integer)
gracePeriodSeconds -
?labelSelector (string)
labelSelector -
?limit (integer)
limit -
?pretty (string)
pretty -
?propagationPolicy (string)
propagationPolicy -
?resourceVersion (string)
resourceVersion -
?resourceVersionMatch (string)
resourceVersionMatch -
?timeoutSeconds (integer)
timeoutSeconds
Response
200 (Status): OK
401: Unauthorized