kubernetes reference title Job kind Job contenttype apireference weight 10 apiVersion batch v1 apimetadata Job represents the configuration of a single job autogenerated true import k8s io api batch v1

Answer:
---
api_metadata:
  apiVersion: "batch/v1"
  import: "k8s.io/api/batch/v1"
  kind: "Job"
content_type: "api_reference"
description: "Job represents the configuration of a single job."
title: "Job"
weight: 10
auto_generated: true
---

`apiVersion: batch/v1`

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

## Job {#Job}

Job represents the configuration of a single job.

- **apiVersion**: batch/v1

- **kind**: Job

- **metadata** (ObjectMeta)

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

- **spec** (JobSpec)

  Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

- **status** (JobStatus)

  Current status of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

## JobSpec {#JobSpec}

JobSpec describes how the job execution will look like.

### Replicas

- **template** (PodTemplateSpec), required

  Describes the pod that will be created when executing a job. The only allowed template.spec.restartPolicy values are "Never" or "OnFailure". More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

- **parallelism** (int32)

  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/

### Lifecycle

- **completions** (int32)

  Specifies the desired number of successfully finished pods the job should be run with.  Setting to null 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/

- **completionMode** (string)

  completionMode specifies how Pod completions are tracked. It can be `NonIndexed` (default) or `Indexed`.

  `NonIndexed` means that the Job is considered complete when there have been .spec.completions successfully completed Pods. Each Pod completion is homologous to each other.

  `Indexed` means that the Pods of a Job get an associated completion index from 0 to (.spec.completions - 1), available in the annotation batch.kubernetes.io/job-completion-index. The Job is considered complete when there is one successfully completed Pod for each index. When value is `Indexed`, .spec.completions must be specified and `.spec.parallelism` must be less than or equal to 10^5. In addition, The Pod name takes the form `$(job-name)-$(index)-$(random-string)`, the Pod hostname takes the form `$(job-name)-$(index)`.

  More completion modes can be added in the future. If the Job controller observes a mode that it doesn't recognize, which is possible during upgrades due to version skew, the controller skips updates for the Job.

- **backoffLimit** (int32)

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

- **activeDeadlineSeconds** (int64)

  Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer. If a Job is suspended (at creation or through an update), this timer will effectively be stopped and reset when the Job is resumed again.

- **ttlSecondsAfterFinished** (int32)

  ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes.

- **suspend** (boolean)

  suspend specifies whether the Job controller should create Pods or not. If a Job is created with suspend set to true, no Pods are created by the Job controller. If a Job is suspended after creation (i.e. the flag goes from false to true), the Job controller will delete all active Pods associated with this Job. Users must design their workload to gracefully handle this. Suspending a Job will reset the StartTime field of the Job, effectively resetting the ActiveDeadlineSeconds timer too. Defaults to false.

### Selector

- **selector** (LabelSelector)

  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

- **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

### Beta level

- **podFailurePolicy** (PodFailurePolicy)

  Specifies the policy of handling failed pods. In particular, it allows to specify the set of actions and conditions which need to be satisfied to take the associated action. If empty, the default behaviour applies - the counter of failed pods, represented by the jobs's .status.failed field, is incremented and it is checked against the backoffLimit. This field cannot be used in combination with restartPolicy=OnFailure.

  *PodFailurePolicy describes how failed pods influence the backoffLimit.*

  - **podFailurePolicy.rules** ([]PodFailurePolicyRule), required

    *Atomic: will be replaced during a merge*

    A list of pod failure policy rules. The rules are evaluated in order. Once a rule matches a Pod failure, the remaining of the rules are ignored. When no rule matches the Pod failure, the default handling applies - the counter of pod failures is incremented and it is checked against the backoffLimit. At most 20 elements are allowed.

    *PodFailurePolicyRule describes how a pod failure is handled when the requirements are met. One of onExitCodes and onPodConditions, but not both, can be used in each rule.*

    - **podFailurePolicy.rules.action** (string), required

      Specifies the action taken on a pod failure when the requirements are satisfied. Possible values are:

      - FailJob: indicates that the pod's job is marked as Failed and all
        running pods are terminated.
      - FailIndex: indicates that the pod's index is marked as Failed and will
        not be restarted.
        This value is beta-level. It can be used when the
        `JobBackoffLimitPerIndex` feature gate is enabled (enabled by default).
      - Ignore: indicates that the counter towards the .backoffLimit is not
        incremented and a replacement pod is created.
      - Count: indicates that the pod is handled in the default way - the
        counter towards the .backoffLimit is incremented.
      Additional values are considered to be added in the future. Clients should react to an unknown action by skipping the rule.

    - **podFailurePolicy.rules.onExitCodes** (PodFailurePolicyOnExitCodesRequirement)

      Represents the requirement on the container exit codes.

      *PodFailurePolicyOnExitCodesRequirement describes the requirement for handling a failed pod based on its container exit codes. In particular, it lookups the .state.terminated.exitCode for each app container and init container status, represented by the .status.containerStatuses and .status.initContainerStatuses fields in the Pod status, respectively. Containers completed with success (exit code 0) are excluded from the requirement check.*

      - **podFailurePolicy.rules.onExitCodes.operator** (string), required

        Represents the relationship between the container exit code(s) and the specified values. Containers completed with success (exit code 0) are excluded from the requirement check. Possible values are:

        - In: the requirement is satisfied if at least one container exit code
          (might be multiple if there are multiple containers not restricted
          by the 'containerName' field) is in the set of specified values.
        - NotIn: the requirement is satisfied if at least one container exit code
          (might be multiple if there are multiple containers not restricted
          by the 'containerName' field) is not in the set of specified values.
        Additional values are considered to be added in the future. Clients should react to an unknown operator by assuming the requirement is not satisfied.

      - **podFailurePolicy.rules.onExitCodes.values** ([]int32), required

        *Set: unique values will be kept during a merge*

        Specifies the set of values. Each returned container exit code (might be multiple in case of multiple containers) is checked against this set of values with respect to the operator. The list of values must be ordered and must not contain duplicates. Value '0' cannot be used for the In operator. At least one element is required. At most 255 elements are allowed.

      - **podFailurePolicy.rules.onExitCodes.containerName** (string)

        Restricts the check for exit codes to the container with the specified name. When null, the rule applies to all containers. When specified, it should match one the container or initContainer names in the pod template.

    - **podFailurePolicy.rules.onPodConditions** ([]PodFailurePolicyOnPodConditionsPattern)

      *Atomic: will be replaced during a merge*

      Represents the requirement on the pod conditions. The requirement is represented as a list of pod condition patterns. The requirement is satisfied if at least one pattern matches an actual pod condition. At most 20 elements are allowed.

      *PodFailurePolicyOnPodConditionsPattern describes a pattern for matching an actual pod condition type.*

      - **podFailurePolicy.rules.onPodConditions.status** (string), required

        Specifies the required Pod condition status. To match a pod condition it is required that the specified status equals the pod condition status. Defaults to True.

      - **podFailurePolicy.rules.onPodConditions.type** (string), required

        Specifies the required Pod condition type. To match a pod condition it is required that specified type equals the pod condition type.

- **successPolicy** (SuccessPolicy)

  successPolicy specifies the policy when the Job can be declared as succeeded. If empty, the default behavior applies - the Job is declared as succeeded only when the number of succeeded pods equals to the completions. When the field is specified, it must be immutable and works only for the Indexed Jobs. Once the Job meets the SuccessPolicy, the lingering pods are terminated.

  This field is beta-level. To use this field, you must enable the `JobSuccessPolicy` feature gate (enabled by default).

  *SuccessPolicy describes when a Job can be declared as succeeded based on the success of some indexes.*

  - **successPolicy.rules** ([]SuccessPolicyRule), required

    *Atomic: will be replaced during a merge*

    rules represents the list of alternative rules for the declaring the Jobs as successful before `.status.succeeded >= .spec.completions`. Once any of the rules are met, the "SucceededCriteriaMet" condition is added, and the lingering pods are removed. The terminal state for such a Job has the "Complete" condition. Additionally, these rules are evaluated in order; Once the Job meets one of the rules, other rules are ignored. At most 20 elements are allowed.

    *SuccessPolicyRule describes rule for declaring a Job as succeeded. Each rule must have at least one of the "succeededIndexes" or "succeededCount" specified.*

    - **successPolicy.rules.succeededCount** (int32)

      succeededCount specifies the minimal required size of the actual set of the succeeded indexes for the Job. When succeededCount is used along with succeededIndexes, the check is constrained only to the set of indexes specified by succeededIndexes. For example, given that succeededIndexes is "1-4", succeededCount is "3", and completed indexes are "1", "3", and "5", the Job isn't declared as succeeded because only "1" and "3" indexes are considered in that rules. When this field is null, this doesn't default to any value and is never evaluated at any time. When specified it needs to be a positive integer.

    - **successPolicy.rules.succeededIndexes** (string)

      succeededIndexes specifies the set of indexes which need to be contained in the actual set of the succeeded indexes for the Job. The list of indexes must be within 0 to ".spec.completions-1" and must not contain duplicates. At least one element is required. The indexes are represented as intervals separated by commas. The intervals can be a decimal integer or a pair of decimal integers separated by a hyphen. The number are listed in represented by the first and last element of the series, separated by a hyphen. For example, if the completed indexes are 1, 3, 4, 5 and 7, they are represented as "1,3-5,7". When this field is null, this field doesn't default to any value and is never evaluated at any time.

### Alpha level

- **backoffLimitPerIndex** (int32)

  Specifies the limit for the number of retries within an index before marking this index as failed. When enabled the number of failures per index is kept in the pod's batch.kubernetes.io/job-index-failure-count annotation. It can only be set when Job's completionMode=Indexed, and the Pod's restart policy is Never. The field is immutable. This field is beta-level. It can be used when the `JobBackoffLimitPerIndex` feature gate is enabled (enabled by default).

- **managedBy** (string)

  ManagedBy field indicates the controller that manages a Job. The k8s Job controller reconciles jobs which don't have this field at all or the field value is the reserved string `kubernetes.io/job-controller`, but skips reconciling Jobs with a custom value for this field. The value must be a valid domain-prefixed path (e.g. acme.io/foo) - all characters before the first "/" must be a valid subdomain as defined by RFC 1123. All characters trailing the first "/" must be valid HTTP Path characters as defined by RFC 3986. The value cannot exceed 63 characters. This field is immutable.

  This field is alpha-level. The job controller accepts setting the field when the feature gate JobManagedBy is enabled (disabled by default).

- **maxFailedIndexes** (int32)

  Specifies the maximal number of failed indexes before marking the Job as failed, when backoffLimitPerIndex is set. Once the number of failed indexes exceeds this number the entire Job is marked as Failed and its execution is terminated. When left as null the job continues execution of all of its indexes and is marked with the `Complete` Job condition. It can only be specified when backoffLimitPerIndex is set. It can be null or up to completions. It is required and must be less than or equal to 10^4 when is completions greater than 10^5. This field is beta-level. It can be used when the `JobBackoffLimitPerIndex` feature gate is enabled (enabled by default).

- **podReplacementPolicy** (string)

  podReplacementPolicy specifies when to create replacement Pods. Possible values are: - TerminatingOrFailed means that we recreate pods
    when they are terminating (has a metadata.deletionTimestamp) or failed.
  - Failed means to wait until a previously created Pod is fully terminated (has phase
    Failed or Succeeded) before creating a replacement Pod.

  When using podFailurePolicy, Failed is the the only allowed value. TerminatingOrFailed and Failed are allowed values when podFailurePolicy is not in use. This is an beta field. To use this, enable the JobPodReplacementPolicy feature toggle. This is on by default.

## JobStatus {#JobStatus}

JobStatus represents the current state of a Job.

- **startTime** (Time)

  Represents time when the job controller started processing a job. When a Job is created in the suspended state, this field is not set until the first time it is resumed. This field is reset every time a Job is resumed from suspension. It is represented in RFC3339 form and is in UTC.

  Once set, the field can only be removed when the job is suspended. The field cannot be modified while the job is unsuspended or finished.

  *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.*

- **completionTime** (Time)

  Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. The completion time is set when the job finishes successfully, and only then. The value cannot be updated or removed. The value indicates the same or later point in time as the startTime field.

  *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.*

- **active** (int32)

  The number of pending and running pods which are not terminating (without a deletionTimestamp). The value is zero for finished jobs.

- **failed** (int32)

  The number of pods which reached phase Failed. The value increases monotonically.

- **succeeded** (int32)

  The number of pods which reached phase Succeeded. The value increases monotonically for a given spec. However, it may decrease in reaction to scale down of elastic indexed jobs.

- **completedIndexes** (string)

  completedIndexes holds the completed indexes when .spec.completionMode = "Indexed" in a text format. The indexes are represented as decimal integers separated by commas. The numbers are listed in increasing order. Three or more consecutive numbers are compressed and represented by the first and last element of the series, separated by a hyphen. For example, if the completed indexes are 1, 3, 4, 5 and 7, they are represented as "1,3-5,7".

- **conditions** ([]JobCondition)

  *Patch strategy: merge on key `type`*

  *Atomic: will be replaced during a merge*

  The latest available observations of an object's current state. When a Job fails, one of the conditions will have type "Failed" and status true. When a Job is suspended, one of the conditions will have type "Suspended" and status true; when the Job is resumed, the status of this condition will become false. When a Job is completed, one of the conditions will have type "Complete" and status true.

  A job is considered finished when it is in a terminal condition, either "Complete" or "Failed". A Job cannot have both the "Complete" and "Failed" conditions. Additionally, it cannot be in the "Complete" and "FailureTarget" conditions. The "Complete", "Failed" and "FailureTarget" conditions cannot be disabled.

  More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

  *JobCondition describes current state of a job.*

  - **conditions.status** (string), required

    Status of the condition, one of True, False, Unknown.

  - **conditions.type** (string), required

    Type of job condition, Complete or Failed.

  - **conditions.lastProbeTime** (Time)

    Last time the condition was checked.

    *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.*

  - **conditions.lastTransitionTime** (Time)

    Last time the condition transit from one status to another.

    *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.*

  - **conditions.message** (string)

    Human readable message indicating details about last transition.

  - **conditions.reason** (string)

    (brief) reason for the condition's last transition.

- **uncountedTerminatedPods** (UncountedTerminatedPods)

  uncountedTerminatedPods holds the UIDs of Pods that have terminated but the job controller hasn't yet accounted for in the status counters.

  The job controller creates pods with a finalizer. When a pod terminates (succeeded or failed), the controller does three steps to account for it in the job status:

  1. Add the pod UID to the arrays in this field. 2. Remove the pod finalizer. 3. Remove the pod UID from the arrays while increasing the corresponding
      counter.

  Old jobs might not be tracked using this field, in which case the field remains null. The structure is empty for finished jobs.

  *UncountedTerminatedPods holds UIDs of Pods that have terminated but haven't been accounted in Job status counters.*

  - **uncountedTerminatedPods.failed** ([]string)

    *Set: unique values will be kept during a merge*

    failed holds UIDs of failed Pods.

  - **uncountedTerminatedPods.succeeded** ([]string)

    *Set: unique values will be kept during a merge*

    succeeded holds UIDs of succeeded Pods.

### Beta level

- **ready** (int32)

  The number of active pods which have a Ready condition and are not terminating (without a deletionTimestamp).

### Alpha level

- **failedIndexes** (string)

  FailedIndexes holds the failed indexes when spec.backoffLimitPerIndex is set. The indexes are represented in the text format analogous as for the `completedIndexes` field, ie. they are kept as decimal integers separated by commas. The numbers are listed in increasing order. Three or more consecutive numbers are compressed and represented by the first and last element of the series, separated by a hyphen. For example, if the failed indexes are 1, 3, 4, 5 and 7, they are represented as "1,3-5,7". The set of failed indexes cannot overlap with the set of completed indexes.

  This field is beta-level. It can be used when the `JobBackoffLimitPerIndex` feature gate is enabled (enabled by default).

- **terminating** (int32)

  The number of pods which are terminating (in phase Pending or Running and have a deletionTimestamp).

  This field is beta-level. The job controller populates the field when the feature gate JobPodReplacementPolicy is enabled (enabled by default).

## JobList {#JobList}

JobList is a collection of jobs.

- **apiVersion**: batch/v1

- **kind**: JobList

- **metadata** (ListMeta)

  Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

- **items** ([]Job), required

  items is the list of Jobs.

## Operations {#Operations}

### `get` read the specified Job

#### HTTP Request

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

#### Parameters

- **name** (*in path*): string, required

  name of the Job

- **namespace** (*in path*): string, required

  namespace

- **pretty** (*in query*): string

  pretty

#### Response

200 (Job): OK

401: Unauthorized

### `get` read status of the specified Job

#### HTTP Request

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

#### Parameters

- **name** (*in path*): string, required

  name of the Job

- **namespace** (*in path*): string, required

  namespace

- **pretty** (*in query*): string

  pretty

#### Response

200 (Job): OK

401: Unauthorized

### `list` list or watch objects of kind Job

#### HTTP Request

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

#### Parameters

- **namespace** (*in path*): string, required

  namespace

- **allowWatchBookmarks** (*in query*): boolean

  allowWatchBookmarks

- **continue** (*in query*): string

  continue

- **fieldSelector** (*in query*): string

  fieldSelector

- **labelSelector** (*in query*): string

  labelSelector

- **limit** (*in query*): integer

  limit

- **pretty** (*in query*): string

  pretty

- **resourceVersion** (*in query*): string

  resourceVersion

- **resourceVersionMatch** (*in query*): string

  resourceVersionMatch

- **sendInitialEvents** (*in query*): boolean

  sendInitialEvents

- **timeoutSeconds** (*in query*): integer

  timeoutSeconds

- **watch** (*in query*): boolean

  watch

#### Response

200 (JobList): OK

401: Unauthorized

### `list` list or watch objects of kind Job

#### HTTP Request

GET /apis/batch/v1/jobs

#### Parameters

- **allowWatchBookmarks** (*in query*): boolean

  allowWatchBookmarks

- **continue** (*in query*): string

  continue

- **fieldSelector** (*in query*): string

  fieldSelector

- **labelSelector** (*in query*): string

  labelSelector

- **limit** (*in query*): integer

  limit

- **pretty** (*in query*): string

  pretty

- **resourceVersion** (*in query*): string

  resourceVersion

- **resourceVersionMatch** (*in query*): string

  resourceVersionMatch

- **sendInitialEvents** (*in query*): boolean

  sendInitialEvents

- **timeoutSeconds** (*in query*): integer

  timeoutSeconds

- **watch** (*in query*): boolean

  watch

#### Response

200 (JobList): OK

401: Unauthorized

### `create` create a Job

#### HTTP Request

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

#### Parameters

- **namespace** (*in path*): string, required

  namespace

- **body**: Job, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **pretty** (*in query*): string

  pretty

#### Response

200 (Job): OK

201 (Job): Created

202 (Job): Accepted

401: Unauthorized

### `update` replace the specified Job

#### HTTP Request

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

#### Parameters

- **name** (*in path*): string, required

  name of the Job

- **namespace** (*in path*): string, required

  namespace

- **body**: Job, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **pretty** (*in query*): string

  pretty

#### Response

200 (Job): OK

201 (Job): Created

401: Unauthorized

### `update` replace status of the specified Job

#### HTTP Request

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

#### Parameters

- **name** (*in path*): string, required

  name of the Job

- **namespace** (*in path*): string, required

  namespace

- **body**: Job, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **pretty** (*in query*): string

  pretty

#### Response

200 (Job): OK

201 (Job): Created

401: Unauthorized

### `patch` partially update the specified Job

#### HTTP Request

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

#### Parameters

- **name** (*in path*): string, required

  name of the Job

- **namespace** (*in path*): string, required

  namespace

- **body**: Patch, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **force** (*in query*): boolean

  force

- **pretty** (*in query*): string

  pretty

#### Response

200 (Job): OK

201 (Job): Created

401: Unauthorized

### `patch` partially update status of the specified Job

#### HTTP Request

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

#### Parameters

- **name** (*in path*): string, required

  name of the Job

- **namespace** (*in path*): string, required

  namespace

- **body**: Patch, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **force** (*in query*): boolean

  force

- **pretty** (*in query*): string

  pretty

#### Response

200 (Job): OK

201 (Job): Created

401: Unauthorized

### `delete` delete a Job

#### HTTP Request

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

#### Parameters

- **name** (*in path*): string, required

  name of the Job

- **namespace** (*in path*): string, required

  namespace

- **body**: DeleteOptions

- **dryRun** (*in query*): string

  dryRun

- **gracePeriodSeconds** (*in query*): integer

  gracePeriodSeconds

- **pretty** (*in query*): string

  pretty

- **propagationPolicy** (*in query*): string

  propagationPolicy

#### Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

### `deletecollection` delete collection of Job

#### HTTP Request

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

#### Parameters

- **namespace** (*in path*): string, required

  namespace

- **body**: DeleteOptions

- **continue** (*in query*): string

  continue

- **dryRun** (*in query*): string

  dryRun

- **fieldSelector** (*in query*): string

  fieldSelector

- **gracePeriodSeconds** (*in query*): integer

  gracePeriodSeconds

- **labelSelector** (*in query*): string

  labelSelector

- **limit** (*in query*): integer

  limit

- **pretty** (*in query*): string

  pretty

- **propagationPolicy** (*in query*): string

  propagationPolicy

- **resourceVersion** (*in query*): string

  resourceVersion

- **resourceVersionMatch** (*in query*): string

  resourceVersionMatch

- **sendInitialEvents** (*in query*): boolean

  sendInitialEvents

- **timeoutSeconds** (*in query*): integer

  timeoutSeconds

#### Response

200 (Status): OK

401: Unauthorized

api metadata    apiVersion   batch v1    import   k8s io api batch v1    kind   Job  content type   api reference  description   Job represents the configuration of a single job   title   Job  weight  10 auto generated  true           The file is auto generated from the Go source code of the component using a generic  generator  https   github com kubernetes sigs reference docs    To learn how to generate the reference documentation  please read  Contributing to the reference documentation   docs contribute generate ref docs    To update the reference content  please follow the   Contributing upstream   docs contribute generate ref docs contribute upstream   guide  You can file document formatting bugs against the  reference docs  https   github com kubernetes sigs reference docs   project        apiVersion  batch v1    import  k8s io api batch v1        Job   Job   Job represents the configuration of a single job    hr       apiVersion    batch v1       kind    Job       metadata     a href    ObjectMeta  a      Standard object s metadata  More info  https   git k8s io community contributors devel sig architecture api conventions md metadata      spec     a href    JobSpec  a      Specification of the desired behavior of a job  More info  https   git k8s io community contributors devel sig architecture api conventions md spec and status      status     a href    JobStatus  a      Current status of a job  More info  https   git k8s io community contributors devel sig architecture api conventions md spec and status         JobSpec   JobSpec   JobSpec describes how the job execution will look like    hr         Replicas       template     a href    PodTemplateSpec  a    required    Describes the pod that will be created when executing a job  The only allowed template spec restartPolicy values are  Never  or  OnFailure   More info  https   kubernetes io docs concepts workloads controllers jobs run to completion       parallelism    int32     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       Lifecycle       completions    int32     Specifies the desired number of successfully finished pods the job should be run with   Setting to null 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       completionMode    string     completionMode specifies how Pod completions are tracked  It can be  NonIndexed   default  or  Indexed         NonIndexed  means that the Job is considered complete when there have been  spec completions successfully completed Pods  Each Pod completion is homologous to each other        Indexed  means that the Pods of a Job get an associated completion index from 0 to   spec completions   1   available in the annotation batch kubernetes io job completion index  The Job is considered complete when there is one successfully completed Pod for each index  When value is  Indexed    spec completions must be specified and   spec parallelism  must be less than or equal to 10 5  In addition  The Pod name takes the form    job name    index    random string    the Pod hostname takes the form    job name    index         More completion modes can be added in the future  If the Job controller observes a mode that it doesn t recognize  which is possible during upgrades due to version skew  the controller skips updates for the Job       backoffLimit    int32     Specifies the number of retries before marking this job failed  Defaults to 6      activeDeadlineSeconds    int64     Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it  value must be positive integer  If a Job is suspended  at creation or through an update   this timer will effectively be stopped and reset when the Job is resumed again       ttlSecondsAfterFinished    int32     ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution  either Complete or Failed   If this field is set  ttlSecondsAfterFinished after the Job finishes  it is eligible to be automatically deleted  When the Job is being deleted  its lifecycle guarantees  e g  finalizers  will be honored  If this field is unset  the Job won t be automatically deleted  If this field is set to zero  the Job becomes eligible to be deleted immediately after it finishes       suspend    boolean     suspend specifies whether the Job controller should create Pods or not  If a Job is created with suspend set to true  no Pods are created by the Job controller  If a Job is suspended after creation  i e  the flag goes from false to true   the Job controller will delete all active Pods associated with this Job  Users must design their workload to gracefully handle this  Suspending a Job will reset the StartTime field of the Job  effectively resetting the ActiveDeadlineSeconds timer too  Defaults to false       Selector       selector     a href    LabelSelector  a      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      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      Beta level       podFailurePolicy    PodFailurePolicy     Specifies the policy of handling failed pods  In particular  it allows to specify the set of actions and conditions which need to be satisfied to take the associated action  If empty  the default behaviour applies   the counter of failed pods  represented by the jobs s  status failed field  is incremented and it is checked against the backoffLimit  This field cannot be used in combination with restartPolicy OnFailure      a name  PodFailurePolicy    a     PodFailurePolicy describes how failed pods influence the backoffLimit          podFailurePolicy rules      PodFailurePolicyRule   required       Atomic  will be replaced during a merge           A list of pod failure policy rules  The rules are evaluated in order  Once a rule matches a Pod failure  the remaining of the rules are ignored  When no rule matches the Pod failure  the default handling applies   the counter of pod failures is incremented and it is checked against the backoffLimit  At most 20 elements are allowed        a name  PodFailurePolicyRule    a       PodFailurePolicyRule describes how a pod failure is handled when the requirements are met  One of onExitCodes and onPodConditions  but not both  can be used in each rule            podFailurePolicy rules action    string   required        Specifies the action taken on a pod failure when the requirements are satisfied  Possible values are                 FailJob  indicates that the pod s job is marked as Failed and all         running pods are terminated          FailIndex  indicates that the pod s index is marked as Failed and will         not be restarted          This value is beta level  It can be used when the          JobBackoffLimitPerIndex  feature gate is enabled  enabled by default           Ignore  indicates that the counter towards the  backoffLimit is not         incremented and a replacement pod is created          Count  indicates that the pod is handled in the default way   the         counter towards the  backoffLimit is incremented        Additional values are considered to be added in the future  Clients should react to an unknown action by skipping the rule           podFailurePolicy rules onExitCodes    PodFailurePolicyOnExitCodesRequirement         Represents the requirement on the container exit codes          a name  PodFailurePolicyOnExitCodesRequirement    a         PodFailurePolicyOnExitCodesRequirement describes the requirement for handling a failed pod based on its container exit codes  In particular  it lookups the  state terminated exitCode for each app container and init container status  represented by the  status containerStatuses and  status initContainerStatuses fields in the Pod status  respectively  Containers completed with success  exit code 0  are excluded from the requirement check              podFailurePolicy rules onExitCodes operator    string   required          Represents the relationship between the container exit code s  and the specified values  Containers completed with success  exit code 0  are excluded from the requirement check  Possible values are                     In  the requirement is satisfied if at least one container exit code            might be multiple if there are multiple containers not restricted           by the  containerName  field  is in the set of specified values            NotIn  the requirement is satisfied if at least one container exit code            might be multiple if there are multiple containers not restricted           by the  containerName  field  is not in the set of specified values          Additional values are considered to be added in the future  Clients should react to an unknown operator by assuming the requirement is not satisfied             podFailurePolicy rules onExitCodes values      int32   required           Set  unique values will be kept during a merge                   Specifies the set of values  Each returned container exit code  might be multiple in case of multiple containers  is checked against this set of values with respect to the operator  The list of values must be ordered and must not contain duplicates  Value  0  cannot be used for the In operator  At least one element is required  At most 255 elements are allowed             podFailurePolicy rules onExitCodes containerName    string           Restricts the check for exit codes to the container with the specified name  When null  the rule applies to all containers  When specified  it should match one the container or initContainer names in the pod template           podFailurePolicy rules onPodConditions      PodFailurePolicyOnPodConditionsPattern          Atomic  will be replaced during a merge               Represents the requirement on the pod conditions  The requirement is represented as a list of pod condition patterns  The requirement is satisfied if at least one pattern matches an actual pod condition  At most 20 elements are allowed          a name  PodFailurePolicyOnPodConditionsPattern    a         PodFailurePolicyOnPodConditionsPattern describes a pattern for matching an actual pod condition type              podFailurePolicy rules onPodConditions status    string   required          Specifies the required Pod condition status  To match a pod condition it is required that the specified status equals the pod condition status  Defaults to True             podFailurePolicy rules onPodConditions type    string   required          Specifies the required Pod condition type  To match a pod condition it is required that specified type equals the pod condition type       successPolicy    SuccessPolicy     successPolicy specifies the policy when the Job can be declared as succeeded  If empty  the default behavior applies   the Job is declared as succeeded only when the number of succeeded pods equals to the completions  When the field is specified  it must be immutable and works only for the Indexed Jobs  Once the Job meets the SuccessPolicy  the lingering pods are terminated       This field is beta level  To use this field  you must enable the  JobSuccessPolicy  feature gate  enabled by default       a name  SuccessPolicy    a     SuccessPolicy describes when a Job can be declared as succeeded based on the success of some indexes          successPolicy rules      SuccessPolicyRule   required       Atomic  will be replaced during a merge           rules represents the list of alternative rules for the declaring the Jobs as successful before   status succeeded     spec completions   Once any of the rules are met  the  SucceededCriteriaMet  condition is added  and the lingering pods are removed  The terminal state for such a Job has the  Complete  condition  Additionally  these rules are evaluated in order  Once the Job meets one of the rules  other rules are ignored  At most 20 elements are allowed        a name  SuccessPolicyRule    a       SuccessPolicyRule describes rule for declaring a Job as succeeded  Each rule must have at least one of the  succeededIndexes  or  succeededCount  specified            successPolicy rules succeededCount    int32         succeededCount specifies the minimal required size of the actual set of the succeeded indexes for the Job  When succeededCount is used along with succeededIndexes  the check is constrained only to the set of indexes specified by succeededIndexes  For example  given that succeededIndexes is  1 4   succeededCount is  3   and completed indexes are  1    3   and  5   the Job isn t declared as succeeded because only  1  and  3  indexes are considered in that rules  When this field is null  this doesn t default to any value and is never evaluated at any time  When specified it needs to be a positive integer           successPolicy rules succeededIndexes    string         succeededIndexes specifies the set of indexes which need to be contained in the actual set of the succeeded indexes for the Job  The list of indexes must be within 0 to   spec completions 1  and must not contain duplicates  At least one element is required  The indexes are represented as intervals separated by commas  The intervals can be a decimal integer or a pair of decimal integers separated by a hyphen  The number are listed in represented by the first and last element of the series  separated by a hyphen  For example  if the completed indexes are 1  3  4  5 and 7  they are represented as  1 3 5 7   When this field is null  this field doesn t default to any value and is never evaluated at any time       Alpha level       backoffLimitPerIndex    int32     Specifies the limit for the number of retries within an index before marking this index as failed  When enabled the number of failures per index is kept in the pod s batch kubernetes io job index failure count annotation  It can only be set when Job s completionMode Indexed  and the Pod s restart policy is Never  The field is immutable  This field is beta level  It can be used when the  JobBackoffLimitPerIndex  feature gate is enabled  enabled by default        managedBy    string     ManagedBy field indicates the controller that manages a Job  The k8s Job controller reconciles jobs which don t have this field at all or the field value is the reserved string  kubernetes io job controller   but skips reconciling Jobs with a custom value for this field  The value must be a valid domain prefixed path  e g  acme io foo    all characters before the first     must be a valid subdomain as defined by RFC 1123  All characters trailing the first     must be valid HTTP Path characters as defined by RFC 3986  The value cannot exceed 63 characters  This field is immutable       This field is alpha level  The job controller accepts setting the field when the feature gate JobManagedBy is enabled  disabled by default        maxFailedIndexes    int32     Specifies the maximal number of failed indexes before marking the Job as failed  when backoffLimitPerIndex is set  Once the number of failed indexes exceeds this number the entire Job is marked as Failed and its execution is terminated  When left as null the job continues execution of all of its indexes and is marked with the  Complete  Job condition  It can only be specified when backoffLimitPerIndex is set  It can be null or up to completions  It is required and must be less than or equal to 10 4 when is completions greater than 10 5  This field is beta level  It can be used when the  JobBackoffLimitPerIndex  feature gate is enabled  enabled by default        podReplacementPolicy    string     podReplacementPolicy specifies when to create replacement Pods  Possible values are    TerminatingOrFailed means that we recreate pods     when they are terminating  has a metadata deletionTimestamp  or failed      Failed means to wait until a previously created Pod is fully terminated  has phase     Failed or Succeeded  before creating a replacement Pod       When using podFailurePolicy  Failed is the the only allowed value  TerminatingOrFailed and Failed are allowed values when podFailurePolicy is not in use  This is an beta field  To use this  enable the JobPodReplacementPolicy feature toggle  This is on by default        JobStatus   JobStatus   JobStatus represents the current state of a Job    hr       startTime    Time     Represents time when the job controller started processing a job  When a Job is created in the suspended state  this field is not set until the first time it is resumed  This field is reset every time a Job is resumed from suspension  It is represented in RFC3339 form and is in UTC       Once set  the field can only be removed when the job is suspended  The field cannot be modified while the job is unsuspended or finished      a name  Time    a     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        completionTime    Time     Represents time when the job was completed  It is not guaranteed to be set in happens before order across separate operations  It is represented in RFC3339 form and is in UTC  The completion time is set when the job finishes successfully  and only then  The value cannot be updated or removed  The value indicates the same or later point in time as the startTime field      a name  Time    a     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        active    int32     The number of pending and running pods which are not terminating  without a deletionTimestamp   The value is zero for finished jobs       failed    int32     The number of pods which reached phase Failed  The value increases monotonically       succeeded    int32     The number of pods which reached phase Succeeded  The value increases monotonically for a given spec  However  it may decrease in reaction to scale down of elastic indexed jobs       completedIndexes    string     completedIndexes holds the completed indexes when  spec completionMode    Indexed  in a text format  The indexes are represented as decimal integers separated by commas  The numbers are listed in increasing order  Three or more consecutive numbers are compressed and represented by the first and last element of the series  separated by a hyphen  For example  if the completed indexes are 1  3  4  5 and 7  they are represented as  1 3 5 7        conditions      JobCondition      Patch strategy  merge on key  type         Atomic  will be replaced during a merge       The latest available observations of an object s current state  When a Job fails  one of the conditions will have type  Failed  and status true  When a Job is suspended  one of the conditions will have type  Suspended  and status true  when the Job is resumed  the status of this condition will become false  When a Job is completed  one of the conditions will have type  Complete  and status true       A job is considered finished when it is in a terminal condition  either  Complete  or  Failed   A Job cannot have both the  Complete  and  Failed  conditions  Additionally  it cannot be in the  Complete  and  FailureTarget  conditions  The  Complete    Failed  and  FailureTarget  conditions cannot be disabled       More info  https   kubernetes io docs concepts workloads controllers jobs run to completion      a name  JobCondition    a     JobCondition describes current state of a job          conditions status    string   required      Status of the condition  one of True  False  Unknown         conditions type    string   required      Type of job condition  Complete or Failed         conditions lastProbeTime    Time       Last time the condition was checked        a name  Time    a       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          conditions lastTransitionTime    Time       Last time the condition transit from one status to another        a name  Time    a       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          conditions message    string       Human readable message indicating details about last transition         conditions reason    string        brief  reason for the condition s last transition       uncountedTerminatedPods    UncountedTerminatedPods     uncountedTerminatedPods holds the UIDs of Pods that have terminated but the job controller hasn t yet accounted for in the status counters       The job controller creates pods with a finalizer  When a pod terminates  succeeded or failed   the controller does three steps to account for it in the job status       1  Add the pod UID to the arrays in this field  2  Remove the pod finalizer  3  Remove the pod UID from the arrays while increasing the corresponding       counter       Old jobs might not be tracked using this field  in which case the field remains null  The structure is empty for finished jobs      a name  UncountedTerminatedPods    a     UncountedTerminatedPods holds UIDs of Pods that have terminated but haven t been accounted in Job status counters          uncountedTerminatedPods failed      string        Set  unique values will be kept during a merge           failed holds UIDs of failed Pods         uncountedTerminatedPods succeeded      string        Set  unique values will be kept during a merge           succeeded holds UIDs of succeeded Pods         Beta level       ready    int32     The number of active pods which have a Ready condition and are not terminating  without a deletionTimestamp        Alpha level       failedIndexes    string     FailedIndexes holds the failed indexes when spec backoffLimitPerIndex is set  The indexes are represented in the text format analogous as for the  completedIndexes  field  ie  they are kept as decimal integers separated by commas  The numbers are listed in increasing order  Three or more consecutive numbers are compressed and represented by the first and last element of the series  separated by a hyphen  For example  if the failed indexes are 1  3  4  5 and 7  they are represented as  1 3 5 7   The set of failed indexes cannot overlap with the set of completed indexes       This field is beta level  It can be used when the  JobBackoffLimitPerIndex  feature gate is enabled  enabled by default        terminating    int32     The number of pods which are terminating  in phase Pending or Running and have a deletionTimestamp        This field is beta level  The job controller populates the field when the feature gate JobPodReplacementPolicy is enabled  enabled by default         JobList   JobList   JobList is a collection of jobs    hr       apiVersion    batch v1       kind    JobList       metadata     a href    ListMeta  a      Standard list metadata  More info  https   git k8s io community contributors devel sig architecture api conventions md metadata      items       a href    Job  a    required    items is the list of Jobs          Operations   Operations      hr             get  read the specified Job       HTTP Request  GET  apis batch v1 namespaces  namespace  jobs  name        Parameters       name     in path    string  required    name of the Job       namespace     in path    string  required     a href    namespace  a        pretty     in query    string     a href    pretty  a          Response   200   a href    Job  a    OK  401  Unauthorized        get  read status of the specified Job       HTTP Request  GET  apis batch v1 namespaces  namespace  jobs  name  status       Parameters       name     in path    string  required    name of the Job       namespace     in path    string  required     a href    namespace  a        pretty     in query    string     a href    pretty  a          Response   200   a href    Job  a    OK  401  Unauthorized        list  list or watch objects of kind Job       HTTP Request  GET  apis batch v1 namespaces  namespace  jobs       Parameters       namespace     in path    string  required     a href    namespace  a        allowWatchBookmarks     in query    boolean     a href    allowWatchBookmarks  a        continue     in query    string     a href    continue  a        fieldSelector     in query    string     a href    fieldSelector  a        labelSelector     in query    string     a href    labelSelector  a        limit     in query    integer     a href    limit  a        pretty     in query    string     a href    pretty  a        resourceVersion     in query    string     a href    resourceVersion  a        resourceVersionMatch     in query    string     a href    resourceVersionMatch  a        sendInitialEvents     in query    boolean     a href    sendInitialEvents  a        timeoutSeconds     in query    integer     a href    timeoutSeconds  a        watch     in query    boolean     a href    watch  a          Response   200   a href    JobList  a    OK  401  Unauthorized        list  list or watch objects of kind Job       HTTP Request  GET  apis batch v1 jobs       Parameters       allowWatchBookmarks     in query    boolean     a href    allowWatchBookmarks  a        continue     in query    string     a href    continue  a        fieldSelector     in query    string     a href    fieldSelector  a        labelSelector     in query    string     a href    labelSelector  a        limit     in query    integer     a href    limit  a        pretty     in query    string     a href    pretty  a        resourceVersion     in query    string     a href    resourceVersion  a        resourceVersionMatch     in query    string     a href    resourceVersionMatch  a        sendInitialEvents     in query    boolean     a href    sendInitialEvents  a        timeoutSeconds     in query    integer     a href    timeoutSeconds  a        watch     in query    boolean     a href    watch  a          Response   200   a href    JobList  a    OK  401  Unauthorized        create  create a Job       HTTP Request  POST  apis batch v1 namespaces  namespace  jobs       Parameters       namespace     in path    string  required     a href    namespace  a        body     a href    Job  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        pretty     in query    string     a href    pretty  a          Response   200   a href    Job  a    OK  201   a href    Job  a    Created  202   a href    Job  a    Accepted  401  Unauthorized        update  replace the specified Job       HTTP Request  PUT  apis batch v1 namespaces  namespace  jobs  name        Parameters       name     in path    string  required    name of the Job       namespace     in path    string  required     a href    namespace  a        body     a href    Job  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        pretty     in query    string     a href    pretty  a          Response   200   a href    Job  a    OK  201   a href    Job  a    Created  401  Unauthorized        update  replace status of the specified Job       HTTP Request  PUT  apis batch v1 namespaces  namespace  jobs  name  status       Parameters       name     in path    string  required    name of the Job       namespace     in path    string  required     a href    namespace  a        body     a href    Job  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        pretty     in query    string     a href    pretty  a          Response   200   a href    Job  a    OK  201   a href    Job  a    Created  401  Unauthorized        patch  partially update the specified Job       HTTP Request  PATCH  apis batch v1 namespaces  namespace  jobs  name        Parameters       name     in path    string  required    name of the Job       namespace     in path    string  required     a href    namespace  a        body     a href    Patch  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        force     in query    boolean     a href    force  a        pretty     in query    string     a href    pretty  a          Response   200   a href    Job  a    OK  201   a href    Job  a    Created  401  Unauthorized        patch  partially update status of the specified Job       HTTP Request  PATCH  apis batch v1 namespaces  namespace  jobs  name  status       Parameters       name     in path    string  required    name of the Job       namespace     in path    string  required     a href    namespace  a        body     a href    Patch  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        force     in query    boolean     a href    force  a        pretty     in query    string     a href    pretty  a          Response   200   a href    Job  a    OK  201   a href    Job  a    Created  401  Unauthorized        delete  delete a Job       HTTP Request  DELETE  apis batch v1 namespaces  namespace  jobs  name        Parameters       name     in path    string  required    name of the Job       namespace     in path    string  required     a href    namespace  a        body     a href    DeleteOptions  a            dryRun     in query    string     a href    dryRun  a        gracePeriodSeconds     in query    integer     a href    gracePeriodSeconds  a        pretty     in query    string     a href    pretty  a        propagationPolicy     in query    string     a href    propagationPolicy  a          Response   200   a href    Status  a    OK  202   a href    Status  a    Accepted  401  Unauthorized        deletecollection  delete collection of Job       HTTP Request  DELETE  apis batch v1 namespaces  namespace  jobs       Parameters       namespace     in path    string  required     a href    namespace  a        body     a href    DeleteOptions  a            continue     in query    string     a href    continue  a        dryRun     in query    string     a href    dryRun  a        fieldSelector     in query    string     a href    fieldSelector  a        gracePeriodSeconds     in query    integer     a href    gracePeriodSeconds  a        labelSelector     in query    string     a href    labelSelector  a        limit     in query    integer     a href    limit  a        pretty     in query    string     a href    pretty  a        propagationPolicy     in query    string     a href    propagationPolicy  a        resourceVersion     in query    string     a href    resourceVersion  a        resourceVersionMatch     in query    string     a href    resourceVersionMatch  a        sendInitialEvents     in query    boolean     a href    sendInitialEvents  a        timeoutSeconds     in query    integer     a href    timeoutSeconds  a          Response   200   a href    Status  a    OK  401  Unauthorized


kubernetes reference weight 5 kind ReplicaSet apiVersion apps v1 contenttype apireference ReplicaSet ensures that a specified number of pod replicas are running at any given time apimetadata title ReplicaSet autogenerated true import k8s io api apps v1

Answer:
---
api_metadata:
  apiVersion: "apps/v1"
  import: "k8s.io/api/apps/v1"
  kind: "ReplicaSet"
content_type: "api_reference"
description: "ReplicaSet ensures that a specified number of pod replicas are running at any given time."
title: "ReplicaSet"
weight: 5
auto_generated: true
---

`apiVersion: apps/v1`

`import "k8s.io/api/apps/v1"`

## ReplicaSet {#ReplicaSet}

ReplicaSet ensures that a specified number of pod replicas are running at any given time.

- **apiVersion**: apps/v1

- **kind**: ReplicaSet

- **metadata** (ObjectMeta)

  If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

- **spec** (ReplicaSetSpec)

  Spec defines the specification of the desired behavior of the ReplicaSet. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

- **status** (ReplicaSetStatus)

  Status is the most recently observed status of the ReplicaSet. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

## ReplicaSetSpec {#ReplicaSetSpec}

ReplicaSetSpec is the specification of a ReplicaSet.

- **selector** (LabelSelector), required

  Selector is a label query over pods that should match the replica count. Label keys and values that must match in order to be controlled by this replica set. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

- **template** (PodTemplateSpec)

  Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template

- **replicas** (int32)

  Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller

- **minReadySeconds** (int32)

  Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)

## ReplicaSetStatus {#ReplicaSetStatus}

ReplicaSetStatus represents the current status of a ReplicaSet.

- **replicas** (int32), required

  Replicas is the most recently observed number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller

- **availableReplicas** (int32)

  The number of available replicas (ready for at least minReadySeconds) for this replica set.

- **readyReplicas** (int32)

  readyReplicas is the number of pods targeted by this ReplicaSet with a Ready Condition.

- **fullyLabeledReplicas** (int32)

  The number of pods that have labels matching the labels of the pod template of the replicaset.

- **conditions** ([]ReplicaSetCondition)

  *Patch strategy: merge on key `type`*

  *Map: unique values on key type will be kept during a merge*

  Represents the latest available observations of a replica set's current state.

  *ReplicaSetCondition describes the state of a replica set at a certain point.*

  - **conditions.status** (string), required

    Status of the condition, one of True, False, Unknown.

  - **conditions.type** (string), required

    Type of replica set condition.

  - **conditions.lastTransitionTime** (Time)

    The last time the condition transitioned from one status to another.

    *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.*

  - **conditions.message** (string)

    A human readable message indicating details about the transition.

  - **conditions.reason** (string)

    The reason for the condition's last transition.

- **observedGeneration** (int64)

  ObservedGeneration reflects the generation of the most recently observed ReplicaSet.

## ReplicaSetList {#ReplicaSetList}

ReplicaSetList is a collection of ReplicaSets.

- **apiVersion**: apps/v1

- **kind**: ReplicaSetList

- **metadata** (ListMeta)

  Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

- **items** ([]ReplicaSet), required

  List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller

## Operations {#Operations}

### `get` read the specified ReplicaSet

#### HTTP Request

GET /apis/apps/v1/namespaces/{namespace}/replicasets/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the ReplicaSet

- **namespace** (*in path*): string, required

  namespace

- **pretty** (*in query*): string

  pretty

#### Response

200 (ReplicaSet): OK

401: Unauthorized

### `get` read status of the specified ReplicaSet

#### HTTP Request

GET /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status

#### Parameters

- **name** (*in path*): string, required

  name of the ReplicaSet

- **namespace** (*in path*): string, required

  namespace

- **pretty** (*in query*): string

  pretty

#### Response

200 (ReplicaSet): OK

401: Unauthorized

### `list` list or watch objects of kind ReplicaSet

#### HTTP Request

GET /apis/apps/v1/namespaces/{namespace}/replicasets

#### Parameters

- **namespace** (*in path*): string, required

  namespace

- **allowWatchBookmarks** (*in query*): boolean

  allowWatchBookmarks

- **continue** (*in query*): string

  continue

- **fieldSelector** (*in query*): string

  fieldSelector

- **labelSelector** (*in query*): string

  labelSelector

- **limit** (*in query*): integer

  limit

- **pretty** (*in query*): string

  pretty

- **resourceVersion** (*in query*): string

  resourceVersion

- **resourceVersionMatch** (*in query*): string

  resourceVersionMatch

- **sendInitialEvents** (*in query*): boolean

  sendInitialEvents

- **timeoutSeconds** (*in query*): integer

  timeoutSeconds

- **watch** (*in query*): boolean

  watch

#### Response

200 (ReplicaSetList): OK

401: Unauthorized

### `list` list or watch objects of kind ReplicaSet

#### HTTP Request

GET /apis/apps/v1/replicasets

#### Parameters

- **allowWatchBookmarks** (*in query*): boolean

  allowWatchBookmarks

- **continue** (*in query*): string

  continue

- **fieldSelector** (*in query*): string

  fieldSelector

- **labelSelector** (*in query*): string

  labelSelector

- **limit** (*in query*): integer

  limit

- **pretty** (*in query*): string

  pretty

- **resourceVersion** (*in query*): string

  resourceVersion

- **resourceVersionMatch** (*in query*): string

  resourceVersionMatch

- **sendInitialEvents** (*in query*): boolean

  sendInitialEvents

- **timeoutSeconds** (*in query*): integer

  timeoutSeconds

- **watch** (*in query*): boolean

  watch

#### Response

200 (ReplicaSetList): OK

401: Unauthorized

### `create` create a ReplicaSet

#### HTTP Request

POST /apis/apps/v1/namespaces/{namespace}/replicasets

#### Parameters

- **namespace** (*in path*): string, required

  namespace

- **body**: ReplicaSet, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **pretty** (*in query*): string

  pretty

#### Response

200 (ReplicaSet): OK

201 (ReplicaSet): Created

202 (ReplicaSet): Accepted

401: Unauthorized

### `update` replace the specified ReplicaSet

#### HTTP Request

PUT /apis/apps/v1/namespaces/{namespace}/replicasets/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the ReplicaSet

- **namespace** (*in path*): string, required

  namespace

- **body**: ReplicaSet, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **pretty** (*in query*): string

  pretty

#### Response

200 (ReplicaSet): OK

201 (ReplicaSet): Created

401: Unauthorized

### `update` replace status of the specified ReplicaSet

#### HTTP Request

PUT /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status

#### Parameters

- **name** (*in path*): string, required

  name of the ReplicaSet

- **namespace** (*in path*): string, required

  namespace

- **body**: ReplicaSet, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **pretty** (*in query*): string

  pretty

#### Response

200 (ReplicaSet): OK

201 (ReplicaSet): Created

401: Unauthorized

### `patch` partially update the specified ReplicaSet

#### HTTP Request

PATCH /apis/apps/v1/namespaces/{namespace}/replicasets/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the ReplicaSet

- **namespace** (*in path*): string, required

  namespace

- **body**: Patch, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **force** (*in query*): boolean

  force

- **pretty** (*in query*): string

  pretty

#### Response

200 (ReplicaSet): OK

201 (ReplicaSet): Created

401: Unauthorized

### `patch` partially update status of the specified ReplicaSet

#### HTTP Request

PATCH /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status

#### Parameters

- **name** (*in path*): string, required

  name of the ReplicaSet

- **namespace** (*in path*): string, required

  namespace

- **body**: Patch, required

- **dryRun** (*in query*): string

  dryRun

- **fieldManager** (*in query*): string

  fieldManager

- **fieldValidation** (*in query*): string

  fieldValidation

- **force** (*in query*): boolean

  force

- **pretty** (*in query*): string

  pretty

#### Response

200 (ReplicaSet): OK

201 (ReplicaSet): Created

401: Unauthorized

### `delete` delete a ReplicaSet

#### HTTP Request

DELETE /apis/apps/v1/namespaces/{namespace}/replicasets/{name}

#### Parameters

- **name** (*in path*): string, required

  name of the ReplicaSet

- **namespace** (*in path*): string, required

  namespace

- **body**: DeleteOptions

- **dryRun** (*in query*): string

  dryRun

- **gracePeriodSeconds** (*in query*): integer

  gracePeriodSeconds

- **pretty** (*in query*): string

  pretty

- **propagationPolicy** (*in query*): string

  propagationPolicy

#### Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

### `deletecollection` delete collection of ReplicaSet

#### HTTP Request

DELETE /apis/apps/v1/namespaces/{namespace}/replicasets

#### Parameters

- **namespace** (*in path*): string, required

  namespace

- **body**: DeleteOptions

- **continue** (*in query*): string

  continue

- **dryRun** (*in query*): string

  dryRun

- **fieldSelector** (*in query*): string

  fieldSelector

- **gracePeriodSeconds** (*in query*): integer

  gracePeriodSeconds

- **labelSelector** (*in query*): string

  labelSelector

- **limit** (*in query*): integer

  limit

- **pretty** (*in query*): string

  pretty

- **propagationPolicy** (*in query*): string

  propagationPolicy

- **resourceVersion** (*in query*): string

  resourceVersion

- **resourceVersionMatch** (*in query*): string

  resourceVersionMatch

- **sendInitialEvents** (*in query*): boolean

  sendInitialEvents

- **timeoutSeconds** (*in query*): integer

  timeoutSeconds

#### Response

200 (Status): OK

401: Unauthorized

api metadata    apiVersion   apps v1    import   k8s io api apps v1    kind   ReplicaSet  content type   api reference  description   ReplicaSet ensures that a specified number of pod replicas are running at any given time   title   ReplicaSet  weight  5 auto generated  true           The file is auto generated from the Go source code of the component using a generic  generator  https   github com kubernetes sigs reference docs    To learn how to generate the reference documentation  please read  Contributing to the reference documentation   docs contribute generate ref docs    To update the reference content  please follow the   Contributing upstream   docs contribute generate ref docs contribute upstream   guide  You can file document formatting bugs against the  reference docs  https   github com kubernetes sigs reference docs   project        apiVersion  apps v1    import  k8s io api apps v1        ReplicaSet   ReplicaSet   ReplicaSet ensures that a specified number of pod replicas are running at any given time    hr       apiVersion    apps v1       kind    ReplicaSet       metadata     a href    ObjectMeta  a      If the Labels of a ReplicaSet are empty  they are defaulted to be the same as the Pod s  that the ReplicaSet manages  Standard object s metadata  More info  https   git k8s io community contributors devel sig architecture api conventions md metadata      spec     a href    ReplicaSetSpec  a      Spec defines the specification of the desired behavior of the ReplicaSet  More info  https   git k8s io community contributors devel sig architecture api conventions md spec and status      status     a href    ReplicaSetStatus  a      Status is the most recently observed status of the ReplicaSet  This data may be out of date by some window of time  Populated by the system  Read only  More info  https   git k8s io community contributors devel sig architecture api conventions md spec and status         ReplicaSetSpec   ReplicaSetSpec   ReplicaSetSpec is the specification of a ReplicaSet    hr       selector     a href    LabelSelector  a    required    Selector is a label query over pods that should match the replica count  Label keys and values that must match in order to be controlled by this replica set  It must match the pod template s labels  More info  https   kubernetes io docs concepts overview working with objects labels  label selectors      template     a href    PodTemplateSpec  a      Template is the object that describes the pod that will be created if insufficient replicas are detected  More info  https   kubernetes io docs concepts workloads controllers replicationcontroller pod template      replicas    int32     Replicas is the number of desired replicas  This is a pointer to distinguish between explicit zero and unspecified  Defaults to 1  More info  https   kubernetes io docs concepts workloads controllers replicationcontroller  what is a replicationcontroller      minReadySeconds    int32     Minimum number of seconds for which a newly created pod should be ready without any of its container crashing  for it to be considered available  Defaults to 0  pod will be considered available as soon as it is ready          ReplicaSetStatus   ReplicaSetStatus   ReplicaSetStatus represents the current status of a ReplicaSet    hr       replicas    int32   required    Replicas is the most recently observed number of replicas  More info  https   kubernetes io docs concepts workloads controllers replicationcontroller  what is a replicationcontroller      availableReplicas    int32     The number of available replicas  ready for at least minReadySeconds  for this replica set       readyReplicas    int32     readyReplicas is the number of pods targeted by this ReplicaSet with a Ready Condition       fullyLabeledReplicas    int32     The number of pods that have labels matching the labels of the pod template of the replicaset       conditions      ReplicaSetCondition      Patch strategy  merge on key  type         Map  unique values on key type will be kept during a merge       Represents the latest available observations of a replica set s current state      a name  ReplicaSetCondition    a     ReplicaSetCondition describes the state of a replica set at a certain point          conditions status    string   required      Status of the condition  one of True  False  Unknown         conditions type    string   required      Type of replica set condition         conditions lastTransitionTime    Time       The last time the condition transitioned from one status to another        a name  Time    a       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          conditions message    string       A human readable message indicating details about the transition         conditions reason    string       The reason for the condition s last transition       observedGeneration    int64     ObservedGeneration reflects the generation of the most recently observed ReplicaSet          ReplicaSetList   ReplicaSetList   ReplicaSetList is a collection of ReplicaSets    hr       apiVersion    apps v1       kind    ReplicaSetList       metadata     a href    ListMeta  a      Standard list metadata  More info  https   git k8s io community contributors devel sig architecture api conventions md types kinds      items       a href    ReplicaSet  a    required    List of ReplicaSets  More info  https   kubernetes io docs concepts workloads controllers replicationcontroller         Operations   Operations      hr             get  read the specified ReplicaSet       HTTP Request  GET  apis apps v1 namespaces  namespace  replicasets  name        Parameters       name     in path    string  required    name of the ReplicaSet       namespace     in path    string  required     a href    namespace  a        pretty     in query    string     a href    pretty  a          Response   200   a href    ReplicaSet  a    OK  401  Unauthorized        get  read status of the specified ReplicaSet       HTTP Request  GET  apis apps v1 namespaces  namespace  replicasets  name  status       Parameters       name     in path    string  required    name of the ReplicaSet       namespace     in path    string  required     a href    namespace  a        pretty     in query    string     a href    pretty  a          Response   200   a href    ReplicaSet  a    OK  401  Unauthorized        list  list or watch objects of kind ReplicaSet       HTTP Request  GET  apis apps v1 namespaces  namespace  replicasets       Parameters       namespace     in path    string  required     a href    namespace  a        allowWatchBookmarks     in query    boolean     a href    allowWatchBookmarks  a        continue     in query    string     a href    continue  a        fieldSelector     in query    string     a href    fieldSelector  a        labelSelector     in query    string     a href    labelSelector  a        limit     in query    integer     a href    limit  a        pretty     in query    string     a href    pretty  a        resourceVersion     in query    string     a href    resourceVersion  a        resourceVersionMatch     in query    string     a href    resourceVersionMatch  a        sendInitialEvents     in query    boolean     a href    sendInitialEvents  a        timeoutSeconds     in query    integer     a href    timeoutSeconds  a        watch     in query    boolean     a href    watch  a          Response   200   a href    ReplicaSetList  a    OK  401  Unauthorized        list  list or watch objects of kind ReplicaSet       HTTP Request  GET  apis apps v1 replicasets       Parameters       allowWatchBookmarks     in query    boolean     a href    allowWatchBookmarks  a        continue     in query    string     a href    continue  a        fieldSelector     in query    string     a href    fieldSelector  a        labelSelector     in query    string     a href    labelSelector  a        limit     in query    integer     a href    limit  a        pretty     in query    string     a href    pretty  a        resourceVersion     in query    string     a href    resourceVersion  a        resourceVersionMatch     in query    string     a href    resourceVersionMatch  a        sendInitialEvents     in query    boolean     a href    sendInitialEvents  a        timeoutSeconds     in query    integer     a href    timeoutSeconds  a        watch     in query    boolean     a href    watch  a          Response   200   a href    ReplicaSetList  a    OK  401  Unauthorized        create  create a ReplicaSet       HTTP Request  POST  apis apps v1 namespaces  namespace  replicasets       Parameters       namespace     in path    string  required     a href    namespace  a        body     a href    ReplicaSet  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        pretty     in query    string     a href    pretty  a          Response   200   a href    ReplicaSet  a    OK  201   a href    ReplicaSet  a    Created  202   a href    ReplicaSet  a    Accepted  401  Unauthorized        update  replace the specified ReplicaSet       HTTP Request  PUT  apis apps v1 namespaces  namespace  replicasets  name        Parameters       name     in path    string  required    name of the ReplicaSet       namespace     in path    string  required     a href    namespace  a        body     a href    ReplicaSet  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        pretty     in query    string     a href    pretty  a          Response   200   a href    ReplicaSet  a    OK  201   a href    ReplicaSet  a    Created  401  Unauthorized        update  replace status of the specified ReplicaSet       HTTP Request  PUT  apis apps v1 namespaces  namespace  replicasets  name  status       Parameters       name     in path    string  required    name of the ReplicaSet       namespace     in path    string  required     a href    namespace  a        body     a href    ReplicaSet  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        pretty     in query    string     a href    pretty  a          Response   200   a href    ReplicaSet  a    OK  201   a href    ReplicaSet  a    Created  401  Unauthorized        patch  partially update the specified ReplicaSet       HTTP Request  PATCH  apis apps v1 namespaces  namespace  replicasets  name        Parameters       name     in path    string  required    name of the ReplicaSet       namespace     in path    string  required     a href    namespace  a        body     a href    Patch  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        force     in query    boolean     a href    force  a        pretty     in query    string     a href    pretty  a          Response   200   a href    ReplicaSet  a    OK  201   a href    ReplicaSet  a    Created  401  Unauthorized        patch  partially update status of the specified ReplicaSet       HTTP Request  PATCH  apis apps v1 namespaces  namespace  replicasets  name  status       Parameters       name     in path    string  required    name of the ReplicaSet       namespace     in path    string  required     a href    namespace  a        body     a href    Patch  a   required           dryRun     in query    string     a href    dryRun  a        fieldManager     in query    string     a href    fieldManager  a        fieldValidation     in query    string     a href    fieldValidation  a        force     in query    boolean     a href    force  a        pretty     in query    string     a href    pretty  a          Response   200   a href    ReplicaSet  a    OK  201   a href    ReplicaSet  a    Created  401  Unauthorized        delete  delete a ReplicaSet       HTTP Request  DELETE  apis apps v1 namespaces  namespace  replicasets  name        Parameters       name     in path    string  required    name of the ReplicaSet       namespace     in path    string  required     a href    namespace  a        body     a href    DeleteOptions  a            dryRun     in query    string     a href    dryRun  a        gracePeriodSeconds     in query    integer     a href    gracePeriodSeconds  a        pretty     in query    string     a href    pretty  a        propagationPolicy     in query    string     a href    propagationPolicy  a          Response   200   a href    Status  a    OK  202   a href    Status  a    Accepted  401  Unauthorized        deletecollection  delete collection of ReplicaSet       HTTP Request  DELETE  apis apps v1 namespaces  namespace  replicasets       Parameters       namespace     in path    string  required     a href    namespace  a        body     a href    DeleteOptions  a            continue     in query    string     a href    continue  a        dryRun     in query    string     a href    dryRun  a        fieldSelector     in query    string     a href    fieldSelector  a        gracePeriodSeconds     in query    integer     a href    gracePeriodSeconds  a        labelSelector     in query    string     a href    labelSelector  a        limit     in query    integer     a href    limit  a        pretty     in query    string     a href    pretty  a        propagationPolicy     in query    string     a href    propagationPolicy  a        resourceVersion     in query    string     a href    resourceVersion  a        resourceVersionMatch     in query    string     a href    resourceVersionMatch  a        sendInitialEvents     in query    boolean     a href    sendInitialEvents  a        timeoutSeconds     in query    integer     a href    timeoutSeconds  a          Response   200   a href    Status  a    OK  401  Unauthorized