This is a cache of https://docs.openshift.com/aro/3/rest_api/batch/cronjob-batch-v1beta1.html. It is a snapshot of the page at 2024-11-20T21:07:41.560+0000.
CronJob [batch/v1beta1] - batch | API reference | Azure Red Hat OpenShift 3
    Soon, all Red Hat OpenShift documentation will only be available on docs.redhat.com, the official location of all Red Hat product documentation. Get familiar with the updated experience today!
  1. Documentation
×

CronJob [batch/v1beta1]

Important

Azure Red Hat OpenShift 3.11 will be retired 30 June 2022. Support for creation of new Azure Red Hat OpenShift 3.11 clusters continues through 30 November 2020. Following retirement, remaining Azure Red Hat OpenShift 3.11 clusters will be shut down to prevent security vulnerabilities.

Follow this guide to create an Azure Red Hat OpenShift 4 cluster. If you have specific questions, please contact us

Specification

Property Type Description

.apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

.kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

.metadata

ObjectMeta meta/v1

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

.spec

object

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

.status

object

CronJobStatus represents the current state of a cron job.
.spec
Description

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

Type

object

Required

  • schedule

  • jobTemplate

Property Type Description

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

integer

The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.

jobTemplate

object

JobTemplateSpec describes the data a Job should have when created from a template

schedule

string

The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.

startingDeadlineSeconds

integer

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

integer

The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 3.

suspend

boolean

This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.
.spec.jobTemplate
Description

JobTemplateSpec describes the data a Job should have when created from a template

Type

object

Property Type Description

metadata

ObjectMeta meta/v1

Standard object’s metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

spec

object

JobSpec describes how the job execution will look like.
.spec.jobTemplate.spec
Description

JobSpec describes how the job execution will look like.

Type

object

Required

  • template

Property Type Description

activeDeadlineSeconds

integer

Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer

backoffLimit

integer

Specifies the number of retries before marking this job failed. Defaults to 6

completions

integer

Specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

manualSelector

boolean

manualSelector controls generation of pod labels and pod selectors. Leave manualSelector unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see manualSelector=true in jobs that were created with the old extensions/v1beta1 API. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector

parallelism

integer

Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

selector

LabelSelector meta/v1

A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

template

PodTemplateSpec core/v1

Describes the pod that will be created when executing a job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
.status
Description

CronJobStatus represents the current state of a cron job.

Type

object

Property Type Description

active

array (ObjectReference core/v1)

A list of pointers to currently running jobs.

lastScheduleTime

Time meta/v1

Information when was the last time the job was successfully scheduled.

API endpoints

The following API endpoints are available:

  • /apis/batch/v1beta1/cronjobs

    • GET: list or watch objects of kind CronJob

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

    • DELETE: delete collection of CronJob

    • GET: list or watch objects of kind CronJob

    • POST: create a CronJob

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

    • DELETE: delete a CronJob

    • GET: read the specified CronJob

    • PATCH: partially update the specified CronJob

    • PUT: replace the specified CronJob

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

    • GET: read status of the specified CronJob

    • PATCH: partially update status of the specified CronJob

    • PUT: replace status of the specified CronJob

/apis/batch/v1beta1/cronjobs

Table 1. Global guery parameters
Parameter Type Description

continue

string

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector

string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

boolean

If true, partially initialized resources are included in the response.

labelSelector

string

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

integer

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

pretty

string

If 'true', then the output is pretty printed.

resourceVersion

string

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

integer

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch

boolean

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
HTTP method

GET

Description

list or watch objects of kind CronJob

Table 2. HTTP responses
HTTP code Reponse body

200 - OK

CronJobList batch/v1beta1

401 - Unauthorized

Empty

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

Table 3. Global path parameters
Parameter Type Description

namespace

string

object name and auth scope, such as for teams and projects
Table 4. Global guery parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.
HTTP method

DELETE

Description

delete collection of CronJob

Table 5. Query parameters
Parameter Type Description

continue

string

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector

string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

boolean

If true, partially initialized resources are included in the response.

labelSelector

string

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

integer

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion

string

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

integer

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch

boolean

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
Table 6. HTTP responses
HTTP code Reponse body

200 - OK

Status meta/v1

401 - Unauthorized

Empty
HTTP method

GET

Description

list or watch objects of kind CronJob

Table 7. Query parameters
Parameter Type Description

continue

string

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector

string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

boolean

If true, partially initialized resources are included in the response.

labelSelector

string

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

integer

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion

string

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

integer

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch

boolean

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
Table 8. HTTP responses
HTTP code Reponse body

200 - OK

CronJobList batch/v1beta1

401 - Unauthorized

Empty
HTTP method

POST

Description

create a CronJob

Table 9. Body parameters
Parameter Type Description

body

CronJob batch/v1beta1
Table 10. HTTP responses
HTTP code Reponse body

200 - OK

CronJob batch/v1beta1

201 - Created

CronJob batch/v1beta1

202 - Accepted

CronJob batch/v1beta1

401 - Unauthorized

Empty

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

Table 11. Global path parameters
Parameter Type Description

name

string

name of the CronJob

namespace

string

object name and auth scope, such as for teams and projects
Table 12. Global guery parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.
HTTP method

DELETE

Description

delete a CronJob

Table 13. Query parameters
Parameter Type Description

gracePeriodSeconds

integer

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

orphanDependents

boolean

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.

propagationPolicy

string

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
Table 14. Body parameters
Parameter Type Description

body

DeleteOptions meta/v1
Table 15. HTTP responses
HTTP code Reponse body

200 - OK

Status meta/v1

401 - Unauthorized

Empty
HTTP method

GET

Description

read the specified CronJob

Table 16. Query parameters
Parameter Type Description

exact

boolean

Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.

export

boolean

Should this value be exported. Export strips fields that a user can not specify.
Table 17. HTTP responses
HTTP code Reponse body

200 - OK

CronJob batch/v1beta1

401 - Unauthorized

Empty
HTTP method

PATCH

Description

partially update the specified CronJob

Table 18. Body parameters
Parameter Type Description

body

Patch meta/v1
Table 19. HTTP responses
HTTP code Reponse body

200 - OK

CronJob batch/v1beta1

401 - Unauthorized

Empty
HTTP method

PUT

Description

replace the specified CronJob

Table 20. Body parameters
Parameter Type Description

body

CronJob batch/v1beta1
Table 21. HTTP responses
HTTP code Reponse body

200 - OK

CronJob batch/v1beta1

201 - Created

CronJob batch/v1beta1

401 - Unauthorized

Empty

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

Table 22. Global path parameters
Parameter Type Description

name

string

name of the CronJob

namespace

string

object name and auth scope, such as for teams and projects
Table 23. Global guery parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.
HTTP method

GET

Description

read status of the specified CronJob

Table 24. HTTP responses
HTTP code Reponse body

200 - OK

CronJob batch/v1beta1

401 - Unauthorized

Empty
HTTP method

PATCH

Description

partially update status of the specified CronJob

Table 25. Body parameters
Parameter Type Description

body

Patch meta/v1
Table 26. HTTP responses
HTTP code Reponse body

200 - OK

CronJob batch/v1beta1

401 - Unauthorized

Empty
HTTP method

PUT

Description

replace status of the specified CronJob

Table 27. Body parameters
Parameter Type Description

body

CronJob batch/v1beta1
Table 28. HTTP responses
HTTP code Reponse body

200 - OK

CronJob batch/v1beta1

201 - Created

CronJob batch/v1beta1

401 - Unauthorized

Empty