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

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

`apiVersion: batch/v1`

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

## CronJob {#CronJob}

CronJob represents the configuration of a single cron job.

- **apiVersion**: batch/v1

- **kind**: CronJob

- **metadata** (ObjectMeta)

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

- **spec** (CronJobSpec)

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

- **status** (CronJobStatus)

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

## CronJobSpec {#CronJobSpec}

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

- **jobTemplate** (JobTemplateSpec), required

  Specifies the job that will be created when executing a CronJob.

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

  - **jobTemplate.metadata** (ObjectMeta)

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

  - **jobTemplate.spec** (JobSpec)

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

- **schedule** (string), required

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

- **timeZone** (string)

  The time zone name for the given schedule, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. If not specified, this will default to the time zone of the kube-controller-manager process. The set of valid time zone names and the time zone offset is loaded from the system-wide time zone database by the API server during CronJob validation and the controller manager during execution. If no system-wide time zone database can be found a bundled version of the database is used instead. If the time zone name becomes invalid during the lifetime of a CronJob or due to a change in host configuration, the controller will stop creating new new Jobs and will create a system event with the reason UnknownTimeZone. More information can be found in https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/#time-zones

- **concurrencyPolicy** (string)

  Specifies how to treat concurrent executions of a Job. Valid values are:

  - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one

- **startingDeadlineSeconds** (int64)

  Optional deadline in seconds for starting the job if it misses scheduled time for any reason.  Missed jobs executions will be counted as failed ones.

- **suspend** (boolean)

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

- **successfulJobsHistoryLimit** (int32)

  The number of successful finished jobs to retain. Value must be non-negative integer. Defaults to 3.

- **failedJobsHistoryLimit** (int32)

  The number of failed finished jobs to retain. Value must be non-negative integer. Defaults to 1.

## CronJobStatus {#CronJobStatus}

CronJobStatus represents the current state of a cron job.

- **active** ([]ObjectReference)

  *Atomic: will be replaced during a merge*

  A list of pointers to currently running jobs.

- **lastScheduleTime** (Time)

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

  *Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON.  Wrappers are provided for many of the factory methods that the time package offers.*

- **lastSuccessfulTime** (Time)

  Information when was the last time the job successfully completed.

  *Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON.  Wrappers are provided for many of the factory methods that the time package offers.*

## CronJobList {#CronJobList}

CronJobList is a collection of cron jobs.

- **apiVersion**: batch/v1

- **kind**: CronJobList

- **metadata** (ListMeta)

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

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

  items is the list of CronJobs.

## Operations {#Operations}

### `get` read the specified CronJob

#### HTTP Request

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

#### Parameters

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

  name of the CronJob

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

  namespace

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

  pretty

#### Response

200 (CronJob): OK

401: Unauthorized

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

#### HTTP Request

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

#### Parameters

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

  name of the CronJob

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

  namespace

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

  pretty

#### Response

200 (CronJob): OK

401: Unauthorized

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

#### HTTP Request

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

#### 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 (CronJobList): OK

401: Unauthorized

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

#### HTTP Request

GET /apis/batch/v1/cronjobs

#### 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 (CronJobList): OK

401: Unauthorized

### `create` create a CronJob

#### HTTP Request

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

#### Parameters

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

  namespace

- **body**: CronJob, required

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

  dryRun

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

  fieldManager

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

  fieldValidation

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

  pretty

#### Response

200 (CronJob): OK

201 (CronJob): Created

202 (CronJob): Accepted

401: Unauthorized

### `update` replace the specified CronJob

#### HTTP Request

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

#### Parameters

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

  name of the CronJob

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

  namespace

- **body**: CronJob, required

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

  dryRun

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

  fieldManager

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

  fieldValidation

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

  pretty

#### Response

200 (CronJob): OK

201 (CronJob): Created

401: Unauthorized

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

#### HTTP Request

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

#### Parameters

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

  name of the CronJob

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

  namespace

- **body**: CronJob, required

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

  dryRun

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

  fieldManager

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

  fieldValidation

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

  pretty

#### Response

200 (CronJob): OK

201 (CronJob): Created

401: Unauthorized

### `patch` partially update the specified CronJob

#### HTTP Request

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

#### Parameters

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

  name of the CronJob

- **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 (CronJob): OK

201 (CronJob): Created

401: Unauthorized

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

#### HTTP Request

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

#### Parameters

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

  name of the CronJob

- **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 (CronJob): OK

201 (CronJob): Created

401: Unauthorized

### `delete` delete a CronJob

#### HTTP Request

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

#### Parameters

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

  name of the CronJob

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

#### HTTP Request

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

#### 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   CronJob  content type   api reference  description   CronJob represents the configuration of a single cron job   title   CronJob  weight  11 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        CronJob   CronJob   CronJob represents the configuration of a single cron job    hr       apiVersion    batch v1       kind    CronJob       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    CronJobSpec  a      Specification of the desired behavior of a cron job  including the schedule  More info  https   git k8s io community contributors devel sig architecture api conventions md spec and status      status     a href    CronJobStatus  a      Current status of a cron job  More info  https   git k8s io community contributors devel sig architecture api conventions md spec and status         CronJobSpec   CronJobSpec   CronJobSpec describes how the job execution will look like and when it will actually run    hr       jobTemplate    JobTemplateSpec   required    Specifies the job that will be created when executing a CronJob      a name  JobTemplateSpec    a     JobTemplateSpec describes the data a Job should have when created from a template         jobTemplate metadata     a href    ObjectMeta  a        Standard object s metadata of the jobs created from this template  More info  https   git k8s io community contributors devel sig architecture api conventions md metadata        jobTemplate spec     a href    JobSpec  a        Specification of the desired behavior of the job  More info  https   git k8s io community contributors devel sig architecture api conventions md spec and status      schedule    string   required    The schedule in Cron format  see https   en wikipedia org wiki Cron       timeZone    string     The time zone name for the given schedule  see https   en wikipedia org wiki List of tz database time zones  If not specified  this will default to the time zone of the kube controller manager process  The set of valid time zone names and the time zone offset is loaded from the system wide time zone database by the API server during CronJob validation and the controller manager during execution  If no system wide time zone database can be found a bundled version of the database is used instead  If the time zone name becomes invalid during the lifetime of a CronJob or due to a change in host configuration  the controller will stop creating new new Jobs and will create a system event with the reason UnknownTimeZone  More information can be found in https   kubernetes io docs concepts workloads controllers cron jobs  time zones      concurrencyPolicy    string     Specifies how to treat concurrent executions of a Job  Valid values are          Allow   default   allows CronJobs to run concurrently     Forbid   forbids concurrent runs  skipping next run if previous run hasn t finished yet     Replace   cancels currently running job and replaces it with a new one      startingDeadlineSeconds    int64     Optional deadline in seconds for starting the job if it misses scheduled time for any reason   Missed jobs executions will be counted as failed ones       suspend    boolean     This flag tells the controller to suspend subsequent executions  it does not apply to already started executions   Defaults to false       successfulJobsHistoryLimit    int32     The number of successful finished jobs to retain  Value must be non negative integer  Defaults to 3       failedJobsHistoryLimit    int32     The number of failed finished jobs to retain  Value must be non negative integer  Defaults to 1          CronJobStatus   CronJobStatus   CronJobStatus represents the current state of a cron job    hr       active       a href    ObjectReference  a       Atomic  will be replaced during a merge       A list of pointers to currently running jobs       lastScheduleTime    Time     Information when was the last time the job was successfully scheduled      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        lastSuccessfulTime    Time     Information when was the last time the job successfully completed      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           CronJobList   CronJobList   CronJobList is a collection of cron jobs    hr       apiVersion    batch v1       kind    CronJobList       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    CronJob  a    required    items is the list of CronJobs          Operations   Operations      hr             get  read the specified CronJob       HTTP Request  GET  apis batch v1 namespaces  namespace  cronjobs  name        Parameters       name     in path    string  required    name of the CronJob       namespace     in path    string  required     a href    namespace  a        pretty     in query    string     a href    pretty  a          Response   200   a href    CronJob  a    OK  401  Unauthorized        get  read status of the specified CronJob       HTTP Request  GET  apis batch v1 namespaces  namespace  cronjobs  name  status       Parameters       name     in path    string  required    name of the CronJob       namespace     in path    string  required     a href    namespace  a        pretty     in query    string     a href    pretty  a          Response   200   a href    CronJob  a    OK  401  Unauthorized        list  list or watch objects of kind CronJob       HTTP Request  GET  apis batch v1 namespaces  namespace  cronjobs       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    CronJobList  a    OK  401  Unauthorized        list  list or watch objects of kind CronJob       HTTP Request  GET  apis batch v1 cronjobs       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    CronJobList  a    OK  401  Unauthorized        create  create a CronJob       HTTP Request  POST  apis batch v1 namespaces  namespace  cronjobs       Parameters       namespace     in path    string  required     a href    namespace  a        body     a href    CronJob  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    CronJob  a    OK  201   a href    CronJob  a    Created  202   a href    CronJob  a    Accepted  401  Unauthorized        update  replace the specified CronJob       HTTP Request  PUT  apis batch v1 namespaces  namespace  cronjobs  name        Parameters       name     in path    string  required    name of the CronJob       namespace     in path    string  required     a href    namespace  a        body     a href    CronJob  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    CronJob  a    OK  201   a href    CronJob  a    Created  401  Unauthorized        update  replace status of the specified CronJob       HTTP Request  PUT  apis batch v1 namespaces  namespace  cronjobs  name  status       Parameters       name     in path    string  required    name of the CronJob       namespace     in path    string  required     a href    namespace  a        body     a href    CronJob  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    CronJob  a    OK  201   a href    CronJob  a    Created  401  Unauthorized        patch  partially update the specified CronJob       HTTP Request  PATCH  apis batch v1 namespaces  namespace  cronjobs  name        Parameters       name     in path    string  required    name of the CronJob       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    CronJob  a    OK  201   a href    CronJob  a    Created  401  Unauthorized        patch  partially update status of the specified CronJob       HTTP Request  PATCH  apis batch v1 namespaces  namespace  cronjobs  name  status       Parameters       name     in path    string  required    name of the CronJob       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    CronJob  a    OK  201   a href    CronJob  a    Created  401  Unauthorized        delete  delete a CronJob       HTTP Request  DELETE  apis batch v1 namespaces  namespace  cronjobs  name        Parameters       name     in path    string  required    name of the CronJob       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 CronJob       HTTP Request  DELETE  apis batch v1 namespaces  namespace  cronjobs       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 kind HorizontalPodAutoscaler apiVersion autoscaling v1 title HorizontalPodAutoscaler configuration of a horizontal pod autoscaler contenttype apireference import k8s io api autoscaling v1 apimetadata weight 12 autogenerated true

Answer:
---
api_metadata:
  apiVersion: "autoscaling/v1"
  import: "k8s.io/api/autoscaling/v1"
  kind: "HorizontalPodAutoscaler"
content_type: "api_reference"
description: "configuration of a horizontal pod autoscaler."
title: "HorizontalPodAutoscaler"
weight: 12
auto_generated: true
---

`apiVersion: autoscaling/v1`

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

## HorizontalPodAutoscaler {#HorizontalPodAutoscaler}

configuration of a horizontal pod autoscaler.

- **apiVersion**: autoscaling/v1

- **kind**: HorizontalPodAutoscaler

- **metadata** (ObjectMeta)

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

- **spec** (HorizontalPodAutoscalerSpec)

  spec defines the behaviour of autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.

- **status** (HorizontalPodAutoscalerStatus)

  status is the current information about the autoscaler.

## HorizontalPodAutoscalerSpec {#HorizontalPodAutoscalerSpec}

specification of a horizontal pod autoscaler.

- **maxReplicas** (int32), required

  maxReplicas is the upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas.

- **scaleTargetRef** (CrossVersionObjectReference), required

  reference to scaled resource; horizontal pod autoscaler will learn the current resource consumption and will set the desired number of pods by using its Scale subresource.

  *CrossVersionObjectReference contains enough information to let you identify the referred resource.*

  - **scaleTargetRef.kind** (string), required

    kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

  - **scaleTargetRef.name** (string), required

    name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

  - **scaleTargetRef.apiVersion** (string)

    apiVersion is the API version of the referent

- **minReplicas** (int32)

  minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down.  It defaults to 1 pod.  minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured.  Scaling is active as long as at least one metric value is available.

- **targetCPUUtilizationPercentage** (int32)

  targetCPUUtilizationPercentage is the target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified the default autoscaling policy will be used.

## HorizontalPodAutoscalerStatus {#HorizontalPodAutoscalerStatus}

current status of a horizontal pod autoscaler

- **currentReplicas** (int32), required

  currentReplicas is the current number of replicas of pods managed by this autoscaler.

- **desiredReplicas** (int32), required

  desiredReplicas is the  desired number of replicas of pods managed by this autoscaler.

- **currentCPUUtilizationPercentage** (int32)

  currentCPUUtilizationPercentage is the current average CPU utilization over all pods, represented as a percentage of requested CPU, e.g. 70 means that an average pod is using now 70% of its requested CPU.

- **lastScaleTime** (Time)

  lastScaleTime is the last time the HorizontalPodAutoscaler scaled the number of pods; used by the autoscaler to control how often the number of pods is changed.

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

- **observedGeneration** (int64)

  observedGeneration is the most recent generation observed by this autoscaler.

## HorizontalPodAutoscalerList {#HorizontalPodAutoscalerList}

list of horizontal pod autoscaler objects.

- **apiVersion**: autoscaling/v1

- **kind**: HorizontalPodAutoscalerList

- **metadata** (ListMeta)

  Standard list metadata.

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

  items is the list of horizontal pod autoscaler objects.

## Operations {#Operations}

### `get` read the specified HorizontalPodAutoscaler

#### HTTP Request

GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}

#### Parameters

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

  name of the HorizontalPodAutoscaler

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

  namespace

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

  pretty

#### Response

200 (HorizontalPodAutoscaler): OK

401: Unauthorized

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

#### HTTP Request

GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status

#### Parameters

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

  name of the HorizontalPodAutoscaler

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

  namespace

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

  pretty

#### Response

200 (HorizontalPodAutoscaler): OK

401: Unauthorized

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

#### HTTP Request

GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers

#### 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 (HorizontalPodAutoscalerList): OK

401: Unauthorized

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

#### HTTP Request

GET /apis/autoscaling/v1/horizontalpodautoscalers

#### 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 (HorizontalPodAutoscalerList): OK

401: Unauthorized

### `create` create a HorizontalPodAutoscaler

#### HTTP Request

POST /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers

#### Parameters

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

  namespace

- **body**: HorizontalPodAutoscaler, required

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

  dryRun

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

  fieldManager

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

  fieldValidation

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

  pretty

#### Response

200 (HorizontalPodAutoscaler): OK

201 (HorizontalPodAutoscaler): Created

202 (HorizontalPodAutoscaler): Accepted

401: Unauthorized

### `update` replace the specified HorizontalPodAutoscaler

#### HTTP Request

PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}

#### Parameters

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

  name of the HorizontalPodAutoscaler

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

  namespace

- **body**: HorizontalPodAutoscaler, required

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

  dryRun

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

  fieldManager

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

  fieldValidation

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

  pretty

#### Response

200 (HorizontalPodAutoscaler): OK

201 (HorizontalPodAutoscaler): Created

401: Unauthorized

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

#### HTTP Request

PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status

#### Parameters

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

  name of the HorizontalPodAutoscaler

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

  namespace

- **body**: HorizontalPodAutoscaler, required

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

  dryRun

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

  fieldManager

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

  fieldValidation

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

  pretty

#### Response

200 (HorizontalPodAutoscaler): OK

201 (HorizontalPodAutoscaler): Created

401: Unauthorized

### `patch` partially update the specified HorizontalPodAutoscaler

#### HTTP Request

PATCH /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}

#### Parameters

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

  name of the HorizontalPodAutoscaler

- **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 (HorizontalPodAutoscaler): OK

201 (HorizontalPodAutoscaler): Created

401: Unauthorized

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

#### HTTP Request

PATCH /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status

#### Parameters

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

  name of the HorizontalPodAutoscaler

- **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 (HorizontalPodAutoscaler): OK

201 (HorizontalPodAutoscaler): Created

401: Unauthorized

### `delete` delete a HorizontalPodAutoscaler

#### HTTP Request

DELETE /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}

#### Parameters

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

  name of the HorizontalPodAutoscaler

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

#### HTTP Request

DELETE /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers

#### 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   autoscaling v1    import   k8s io api autoscaling v1    kind   HorizontalPodAutoscaler  content type   api reference  description   configuration of a horizontal pod autoscaler   title   HorizontalPodAutoscaler  weight  12 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  autoscaling v1    import  k8s io api autoscaling v1        HorizontalPodAutoscaler   HorizontalPodAutoscaler   configuration of a horizontal pod autoscaler    hr       apiVersion    autoscaling v1       kind    HorizontalPodAutoscaler       metadata     a href    ObjectMeta  a      Standard object metadata  More info  https   git k8s io community contributors devel sig architecture api conventions md metadata      spec     a href    HorizontalPodAutoscalerSpec  a      spec defines the behaviour of autoscaler  More info  https   git k8s io community contributors devel sig architecture api conventions md spec and status       status     a href    HorizontalPodAutoscalerStatus  a      status is the current information about the autoscaler          HorizontalPodAutoscalerSpec   HorizontalPodAutoscalerSpec   specification of a horizontal pod autoscaler    hr       maxReplicas    int32   required    maxReplicas is the upper limit for the number of pods that can be set by the autoscaler  cannot be smaller than MinReplicas       scaleTargetRef    CrossVersionObjectReference   required    reference to scaled resource  horizontal pod autoscaler will learn the current resource consumption and will set the desired number of pods by using its Scale subresource      a name  CrossVersionObjectReference    a     CrossVersionObjectReference contains enough information to let you identify the referred resource          scaleTargetRef kind    string   required      kind is the kind of the referent  More info  https   git k8s io community contributors devel sig architecture api conventions md types kinds        scaleTargetRef name    string   required      name is the name of the referent  More info  https   kubernetes io docs concepts overview working with objects names  names        scaleTargetRef apiVersion    string       apiVersion is the API version of the referent      minReplicas    int32     minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down   It defaults to 1 pod   minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured   Scaling is active as long as at least one metric value is available       targetCPUUtilizationPercentage    int32     targetCPUUtilizationPercentage is the target average CPU utilization  represented as a percentage of requested CPU  over all the pods  if not specified the default autoscaling policy will be used          HorizontalPodAutoscalerStatus   HorizontalPodAutoscalerStatus   current status of a horizontal pod autoscaler   hr       currentReplicas    int32   required    currentReplicas is the current number of replicas of pods managed by this autoscaler       desiredReplicas    int32   required    desiredReplicas is the  desired number of replicas of pods managed by this autoscaler       currentCPUUtilizationPercentage    int32     currentCPUUtilizationPercentage is the current average CPU utilization over all pods  represented as a percentage of requested CPU  e g  70 means that an average pod is using now 70  of its requested CPU       lastScaleTime    Time     lastScaleTime is the last time the HorizontalPodAutoscaler scaled the number of pods  used by the autoscaler to control how often the number of pods is changed      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        observedGeneration    int64     observedGeneration is the most recent generation observed by this autoscaler          HorizontalPodAutoscalerList   HorizontalPodAutoscalerList   list of horizontal pod autoscaler objects    hr       apiVersion    autoscaling v1       kind    HorizontalPodAutoscalerList       metadata     a href    ListMeta  a      Standard list metadata       items       a href    HorizontalPodAutoscaler  a    required    items is the list of horizontal pod autoscaler objects          Operations   Operations      hr             get  read the specified HorizontalPodAutoscaler       HTTP Request  GET  apis autoscaling v1 namespaces  namespace  horizontalpodautoscalers  name        Parameters       name     in path    string  required    name of the HorizontalPodAutoscaler       namespace     in path    string  required     a href    namespace  a        pretty     in query    string     a href    pretty  a          Response   200   a href    HorizontalPodAutoscaler  a    OK  401  Unauthorized        get  read status of the specified HorizontalPodAutoscaler       HTTP Request  GET  apis autoscaling v1 namespaces  namespace  horizontalpodautoscalers  name  status       Parameters       name     in path    string  required    name of the HorizontalPodAutoscaler       namespace     in path    string  required     a href    namespace  a        pretty     in query    string     a href    pretty  a          Response   200   a href    HorizontalPodAutoscaler  a    OK  401  Unauthorized        list  list or watch objects of kind HorizontalPodAutoscaler       HTTP Request  GET  apis autoscaling v1 namespaces  namespace  horizontalpodautoscalers       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    HorizontalPodAutoscalerList  a    OK  401  Unauthorized        list  list or watch objects of kind HorizontalPodAutoscaler       HTTP Request  GET  apis autoscaling v1 horizontalpodautoscalers       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    HorizontalPodAutoscalerList  a    OK  401  Unauthorized        create  create a HorizontalPodAutoscaler       HTTP Request  POST  apis autoscaling v1 namespaces  namespace  horizontalpodautoscalers       Parameters       namespace     in path    string  required     a href    namespace  a        body     a href    HorizontalPodAutoscaler  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    HorizontalPodAutoscaler  a    OK  201   a href    HorizontalPodAutoscaler  a    Created  202   a href    HorizontalPodAutoscaler  a    Accepted  401  Unauthorized        update  replace the specified HorizontalPodAutoscaler       HTTP Request  PUT  apis autoscaling v1 namespaces  namespace  horizontalpodautoscalers  name        Parameters       name     in path    string  required    name of the HorizontalPodAutoscaler       namespace     in path    string  required     a href    namespace  a        body     a href    HorizontalPodAutoscaler  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    HorizontalPodAutoscaler  a    OK  201   a href    HorizontalPodAutoscaler  a    Created  401  Unauthorized        update  replace status of the specified HorizontalPodAutoscaler       HTTP Request  PUT  apis autoscaling v1 namespaces  namespace  horizontalpodautoscalers  name  status       Parameters       name     in path    string  required    name of the HorizontalPodAutoscaler       namespace     in path    string  required     a href    namespace  a        body     a href    HorizontalPodAutoscaler  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    HorizontalPodAutoscaler  a    OK  201   a href    HorizontalPodAutoscaler  a    Created  401  Unauthorized        patch  partially update the specified HorizontalPodAutoscaler       HTTP Request  PATCH  apis autoscaling v1 namespaces  namespace  horizontalpodautoscalers  name        Parameters       name     in path    string  required    name of the HorizontalPodAutoscaler       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    HorizontalPodAutoscaler  a    OK  201   a href    HorizontalPodAutoscaler  a    Created  401  Unauthorized        patch  partially update status of the specified HorizontalPodAutoscaler       HTTP Request  PATCH  apis autoscaling v1 namespaces  namespace  horizontalpodautoscalers  name  status       Parameters       name     in path    string  required    name of the HorizontalPodAutoscaler       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    HorizontalPodAutoscaler  a    OK  201   a href    HorizontalPodAutoscaler  a    Created  401  Unauthorized        delete  delete a HorizontalPodAutoscaler       HTTP Request  DELETE  apis autoscaling v1 namespaces  namespace  horizontalpodautoscalers  name        Parameters       name     in path    string  required    name of the HorizontalPodAutoscaler       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 HorizontalPodAutoscaler       HTTP Request  DELETE  apis autoscaling v1 namespaces  namespace  horizontalpodautoscalers       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 7 title StatefulSet StatefulSet represents a set of pods with consistent identities apiVersion apps v1 contenttype apireference apimetadata kind StatefulSet autogenerated true import k8s io api apps v1

Answer:
---
api_metadata:
  apiVersion: "apps/v1"
  import: "k8s.io/api/apps/v1"
  kind: "StatefulSet"
content_type: "api_reference"
description: "StatefulSet represents a set of pods with consistent identities."
title: "StatefulSet"
weight: 7
auto_generated: true
---

`apiVersion: apps/v1`

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

## StatefulSet {#StatefulSet}

StatefulSet represents a set of pods with consistent identities. Identities are defined as:
  - Network: A single stable DNS and hostname.
  - Storage: As many VolumeClaims as requested.

The StatefulSet guarantees that a given network identity will always map to the same storage identity.

- **apiVersion**: apps/v1

- **kind**: StatefulSet

- **metadata** (ObjectMeta)

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

- **spec** (StatefulSetSpec)

  Spec defines the desired identities of pods in this set.

- **status** (StatefulSetStatus)

  Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.

## StatefulSetSpec {#StatefulSetSpec}

A StatefulSetSpec is the specification of a StatefulSet.

- **serviceName** (string), required

  serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.

- **selector** (LabelSelector), required

  selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

- **template** (PodTemplateSpec), required

  template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet. Each pod will be named with the format \<statefulsetname>-\<podindex>. For example, a pod in a StatefulSet named "web" with index number "3" would be named "web-3". The only allowed template.spec.restartPolicy value is "Always".

- **replicas** (int32)

  replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.

- **updateStrategy** (StatefulSetUpdateStrategy)

  updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.

  *StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.*

  - **updateStrategy.type** (string)

    Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.

  - **updateStrategy.rollingUpdate** (RollingUpdateStatefulSetStrategy)

    RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType.

    *RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.*

    - **updateStrategy.rollingUpdate.maxUnavailable** (IntOrString)

      The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding up. This can not be 0. Defaults to 1. This field is alpha-level and is only honored by servers that enable the MaxUnavailableStatefulSet feature. The field applies to all pods in the range 0 to Replicas-1. That means if there is any unavailable pod in the range 0 to Replicas-1, it will be counted towards MaxUnavailable.

      *IntOrString is a type that can hold an int32 or a string.  When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type.  This allows you to have, for example, a JSON field that can accept a name or number.*

    - **updateStrategy.rollingUpdate.partition** (int32)

      Partition indicates the ordinal at which the StatefulSet should be partitioned for updates. During a rolling update, all pods from ordinal Replicas-1 to Partition are updated. All pods from ordinal Partition-1 to 0 remain untouched. This is helpful in being able to do a canary based deployment. The default value is 0.

- **podManagementPolicy** (string)

  podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is `Parallel` which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.

- **revisionHistoryLimit** (int32)

  revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.

- **volumeClaimTemplates** ([]PersistentVolumeClaim)

  *Atomic: will be replaced during a merge*

  volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.

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

- **persistentVolumeClaimRetentionPolicy** (StatefulSetPersistentVolumeClaimRetentionPolicy)

  persistentVolumeClaimRetentionPolicy describes the lifecycle of persistent volume claims created from volumeClaimTemplates. By default, all persistent volume claims are created as needed and retained until manually deleted. This policy allows the lifecycle to be altered, for example by deleting persistent volume claims when their stateful set is deleted, or when their pod is scaled down. This requires the StatefulSetAutoDeletePVC feature gate to be enabled, which is beta.

  *StatefulSetPersistentVolumeClaimRetentionPolicy describes the policy used for PVCs created from the StatefulSet VolumeClaimTemplates.*

  - **persistentVolumeClaimRetentionPolicy.whenDeleted** (string)

    WhenDeleted specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is deleted. The default policy of `Retain` causes PVCs to not be affected by StatefulSet deletion. The `Delete` policy causes those PVCs to be deleted.

  - **persistentVolumeClaimRetentionPolicy.whenScaled** (string)

    WhenScaled specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is scaled down. The default policy of `Retain` causes PVCs to not be affected by a scaledown. The `Delete` policy causes the associated PVCs for any excess pods above the replica count to be deleted.

- **ordinals** (StatefulSetOrdinals)

  ordinals controls the numbering of replica indices in a StatefulSet. The default ordinals behavior assigns a "0" index to the first replica and increments the index by one for each additional replica requested.

  *StatefulSetOrdinals describes the policy used for replica ordinal assignment in this StatefulSet.*

  - **ordinals.start** (int32)

    start is the number representing the first replica's index. It may be used to number replicas from an alternate index (eg: 1-indexed) over the default 0-indexed names, or to orchestrate progressive movement of replicas from one StatefulSet to another. If set, replica indices will be in the range:
      [.spec.ordinals.start, .spec.ordinals.start + .spec.replicas).
    If unset, defaults to 0. Replica indices will be in the range:
      [0, .spec.replicas).

## StatefulSetStatus {#StatefulSetStatus}

StatefulSetStatus represents the current state of a StatefulSet.

- **replicas** (int32), required

  replicas is the number of Pods created by the StatefulSet controller.

- **readyReplicas** (int32)

  readyReplicas is the number of pods created for this StatefulSet with a Ready Condition.

- **currentReplicas** (int32)

  currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision.

- **updatedReplicas** (int32)

  updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision.

- **availableReplicas** (int32)

  Total number of available pods (ready for at least minReadySeconds) targeted by this statefulset.

- **collisionCount** (int32)

  collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.

- **conditions** ([]StatefulSetCondition)

  *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 statefulset's current state.

  *StatefulSetCondition describes the state of a statefulset at a certain point.*

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

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

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

    Type of statefulset condition.

  - **conditions.lastTransitionTime** (Time)

    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.

- **currentRevision** (string)

  currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).

- **updateRevision** (string)

  updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas)

- **observedGeneration** (int64)

  observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the StatefulSet's generation, which is updated on mutation by the API Server.

## StatefulSetList {#StatefulSetList}

StatefulSetList is a collection of StatefulSets.

- **apiVersion**: apps/v1

- **kind**: StatefulSetList

- **metadata** (ListMeta)

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

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

  Items is the list of stateful sets.

## Operations {#Operations}

### `get` read the specified StatefulSet

#### HTTP Request

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

#### Parameters

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

  name of the StatefulSet

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

  namespace

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

  pretty

#### Response

200 (StatefulSet): OK

401: Unauthorized

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

#### HTTP Request

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

#### Parameters

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

  name of the StatefulSet

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

  namespace

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

  pretty

#### Response

200 (StatefulSet): OK

401: Unauthorized

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

#### HTTP Request

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

#### 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 (StatefulSetList): OK

401: Unauthorized

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

#### HTTP Request

GET /apis/apps/v1/statefulsets

#### 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 (StatefulSetList): OK

401: Unauthorized

### `create` create a StatefulSet

#### HTTP Request

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

#### Parameters

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

  namespace

- **body**: StatefulSet, required

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

  dryRun

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

  fieldManager

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

  fieldValidation

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

  pretty

#### Response

200 (StatefulSet): OK

201 (StatefulSet): Created

202 (StatefulSet): Accepted

401: Unauthorized

### `update` replace the specified StatefulSet

#### HTTP Request

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

#### Parameters

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

  name of the StatefulSet

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

  namespace

- **body**: StatefulSet, required

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

  dryRun

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

  fieldManager

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

  fieldValidation

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

  pretty

#### Response

200 (StatefulSet): OK

201 (StatefulSet): Created

401: Unauthorized

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

#### HTTP Request

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

#### Parameters

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

  name of the StatefulSet

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

  namespace

- **body**: StatefulSet, required

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

  dryRun

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

  fieldManager

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

  fieldValidation

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

  pretty

#### Response

200 (StatefulSet): OK

201 (StatefulSet): Created

401: Unauthorized

### `patch` partially update the specified StatefulSet

#### HTTP Request

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

#### Parameters

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

  name of the StatefulSet

- **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 (StatefulSet): OK

201 (StatefulSet): Created

401: Unauthorized

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

#### HTTP Request

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

#### Parameters

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

  name of the StatefulSet

- **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 (StatefulSet): OK

201 (StatefulSet): Created

401: Unauthorized

### `delete` delete a StatefulSet

#### HTTP Request

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

#### Parameters

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

  name of the StatefulSet

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

#### HTTP Request

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

#### 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   StatefulSet  content type   api reference  description   StatefulSet represents a set of pods with consistent identities   title   StatefulSet  weight  7 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        StatefulSet   StatefulSet   StatefulSet represents a set of pods with consistent identities  Identities are defined as      Network  A single stable DNS and hostname      Storage  As many VolumeClaims as requested   The StatefulSet guarantees that a given network identity will always map to the same storage identity    hr       apiVersion    apps v1       kind    StatefulSet       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    StatefulSetSpec  a      Spec defines the desired identities of pods in this set       status     a href    StatefulSetStatus  a      Status is the current status of Pods in this StatefulSet  This data may be out of date by some window of time          StatefulSetSpec   StatefulSetSpec   A StatefulSetSpec is the specification of a StatefulSet    hr       serviceName    string   required    serviceName is the name of the service that governs this StatefulSet  This service must exist before the StatefulSet  and is responsible for the network identity of the set  Pods get DNS hostnames that follow the pattern  pod specific string serviceName default svc cluster local where  pod specific string  is managed by the StatefulSet controller       selector     a href    LabelSelector  a    required    selector is a label query over pods that should match the replica count  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    required    template is the object that describes the pod that will be created if insufficient replicas are detected  Each pod stamped out by the StatefulSet will fulfill this Template  but have a unique identity from the rest of the StatefulSet  Each pod will be named with the format   statefulsetname    podindex   For example  a pod in a StatefulSet named  web  with index number  3  would be named  web 3   The only allowed template spec restartPolicy value is  Always        replicas    int32     replicas is the desired number of replicas of the given Template  These are replicas in the sense that they are instantiations of the same Template  but individual replicas also have a consistent identity  If unspecified  defaults to 1       updateStrategy    StatefulSetUpdateStrategy     updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template      a name  StatefulSetUpdateStrategy    a     StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates  It includes any additional parameters necessary to perform the update for the indicated strategy          updateStrategy type    string       Type indicates the type of the StatefulSetUpdateStrategy  Default is RollingUpdate         updateStrategy rollingUpdate    RollingUpdateStatefulSetStrategy       RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType        a name  RollingUpdateStatefulSetStrategy    a       RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType            updateStrategy rollingUpdate maxUnavailable    IntOrString         The maximum number of pods that can be unavailable during the update  Value can be an absolute number  ex  5  or a percentage of desired pods  ex  10    Absolute number is calculated from percentage by rounding up  This can not be 0  Defaults to 1  This field is alpha level and is only honored by servers that enable the MaxUnavailableStatefulSet feature  The field applies to all pods in the range 0 to Replicas 1  That means if there is any unavailable pod in the range 0 to Replicas 1  it will be counted towards MaxUnavailable          a name  IntOrString    a         IntOrString is a type that can hold an int32 or a string   When used in JSON or YAML marshalling and unmarshalling  it produces or consumes the inner type   This allows you to have  for example  a JSON field that can accept a name or number            updateStrategy rollingUpdate partition    int32         Partition indicates the ordinal at which the StatefulSet should be partitioned for updates  During a rolling update  all pods from ordinal Replicas 1 to Partition are updated  All pods from ordinal Partition 1 to 0 remain untouched  This is helpful in being able to do a canary based deployment  The default value is 0       podManagementPolicy    string     podManagementPolicy controls how pods are created during initial scale up  when replacing pods on nodes  or when scaling down  The default policy is  OrderedReady   where pods are created in increasing order  pod 0  then pod 1  etc  and the controller will wait until each pod is ready before continuing  When scaling down  the pods are removed in the opposite order  The alternative policy is  Parallel  which will create pods in parallel to match the desired scale without waiting  and on scale down will delete all pods at once       revisionHistoryLimit    int32     revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet s revision history  The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version  The default value is 10       volumeClaimTemplates       a href    PersistentVolumeClaim  a       Atomic  will be replaced during a merge       volumeClaimTemplates is a list of claims that pods are allowed to reference  The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod  Every claim in this list must have at least one matching  by name  volumeMount in one container in the template  A claim in this list takes precedence over any volumes in the template  with the same name       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       persistentVolumeClaimRetentionPolicy    StatefulSetPersistentVolumeClaimRetentionPolicy     persistentVolumeClaimRetentionPolicy describes the lifecycle of persistent volume claims created from volumeClaimTemplates  By default  all persistent volume claims are created as needed and retained until manually deleted  This policy allows the lifecycle to be altered  for example by deleting persistent volume claims when their stateful set is deleted  or when their pod is scaled down  This requires the StatefulSetAutoDeletePVC feature gate to be enabled  which is beta      a name  StatefulSetPersistentVolumeClaimRetentionPolicy    a     StatefulSetPersistentVolumeClaimRetentionPolicy describes the policy used for PVCs created from the StatefulSet VolumeClaimTemplates          persistentVolumeClaimRetentionPolicy whenDeleted    string       WhenDeleted specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is deleted  The default policy of  Retain  causes PVCs to not be affected by StatefulSet deletion  The  Delete  policy causes those PVCs to be deleted         persistentVolumeClaimRetentionPolicy whenScaled    string       WhenScaled specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is scaled down  The default policy of  Retain  causes PVCs to not be affected by a scaledown  The  Delete  policy causes the associated PVCs for any excess pods above the replica count to be deleted       ordinals    StatefulSetOrdinals     ordinals controls the numbering of replica indices in a StatefulSet  The default ordinals behavior assigns a  0  index to the first replica and increments the index by one for each additional replica requested      a name  StatefulSetOrdinals    a     StatefulSetOrdinals describes the policy used for replica ordinal assignment in this StatefulSet          ordinals start    int32       start is the number representing the first replica s index  It may be used to number replicas from an alternate index  eg  1 indexed  over the default 0 indexed names  or to orchestrate progressive movement of replicas from one StatefulSet to another  If set  replica indices will be in the range          spec ordinals start   spec ordinals start    spec replicas       If unset  defaults to 0  Replica indices will be in the range         0   spec replicas           StatefulSetStatus   StatefulSetStatus   StatefulSetStatus represents the current state of a StatefulSet    hr       replicas    int32   required    replicas is the number of Pods created by the StatefulSet controller       readyReplicas    int32     readyReplicas is the number of pods created for this StatefulSet with a Ready Condition       currentReplicas    int32     currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision       updatedReplicas    int32     updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision       availableReplicas    int32     Total number of available pods  ready for at least minReadySeconds  targeted by this statefulset       collisionCount    int32     collisionCount is the count of hash collisions for the StatefulSet  The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision       conditions      StatefulSetCondition      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 statefulset s current state      a name  StatefulSetCondition    a     StatefulSetCondition describes the state of a statefulset at a certain point          conditions status    string   required      Status of the condition  one of True  False  Unknown         conditions type    string   required      Type of statefulset condition         conditions lastTransitionTime    Time       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       currentRevision    string     currentRevision  if not empty  indicates the version of the StatefulSet used to generate Pods in the sequence  0 currentReplicas        updateRevision    string     updateRevision  if not empty  indicates the version of the StatefulSet used to generate Pods in the sequence  replicas updatedReplicas replicas       observedGeneration    int64     observedGeneration is the most recent generation observed for this StatefulSet  It corresponds to the StatefulSet s generation  which is updated on mutation by the API Server          StatefulSetList   StatefulSetList   StatefulSetList is a collection of StatefulSets    hr       apiVersion    apps v1       kind    StatefulSetList       metadata     a href    ListMeta  a      Standard list s metadata  More info  https   git k8s io community contributors devel sig architecture api conventions md metadata      items       a href    StatefulSet  a    required    Items is the list of stateful sets          Operations   Operations      hr             get  read the specified StatefulSet       HTTP Request  GET  apis apps v1 namespaces  namespace  statefulsets  name        Parameters       name     in path    string  required    name of the StatefulSet       namespace     in path    string  required     a href    namespace  a        pretty     in query    string     a href    pretty  a          Response   200   a href    StatefulSet  a    OK  401  Unauthorized        get  read status of the specified StatefulSet       HTTP Request  GET  apis apps v1 namespaces  namespace  statefulsets  name  status       Parameters       name     in path    string  required    name of the StatefulSet       namespace     in path    string  required     a href    namespace  a        pretty     in query    string     a href    pretty  a          Response   200   a href    StatefulSet  a    OK  401  Unauthorized        list  list or watch objects of kind StatefulSet       HTTP Request  GET  apis apps v1 namespaces  namespace  statefulsets       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    StatefulSetList  a    OK  401  Unauthorized        list  list or watch objects of kind StatefulSet       HTTP Request  GET  apis apps v1 statefulsets       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    StatefulSetList  a    OK  401  Unauthorized        create  create a StatefulSet       HTTP Request  POST  apis apps v1 namespaces  namespace  statefulsets       Parameters       namespace     in path    string  required     a href    namespace  a        body     a href    StatefulSet  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    StatefulSet  a    OK  201   a href    StatefulSet  a    Created  202   a href    StatefulSet  a    Accepted  401  Unauthorized        update  replace the specified StatefulSet       HTTP Request  PUT  apis apps v1 namespaces  namespace  statefulsets  name        Parameters       name     in path    string  required    name of the StatefulSet       namespace     in path    string  required     a href    namespace  a        body     a href    StatefulSet  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    StatefulSet  a    OK  201   a href    StatefulSet  a    Created  401  Unauthorized        update  replace status of the specified StatefulSet       HTTP Request  PUT  apis apps v1 namespaces  namespace  statefulsets  name  status       Parameters       name     in path    string  required    name of the StatefulSet       namespace     in path    string  required     a href    namespace  a        body     a href    StatefulSet  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    StatefulSet  a    OK  201   a href    StatefulSet  a    Created  401  Unauthorized        patch  partially update the specified StatefulSet       HTTP Request  PATCH  apis apps v1 namespaces  namespace  statefulsets  name        Parameters       name     in path    string  required    name of the StatefulSet       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    StatefulSet  a    OK  201   a href    StatefulSet  a    Created  401  Unauthorized        patch  partially update status of the specified StatefulSet       HTTP Request  PATCH  apis apps v1 namespaces  namespace  statefulsets  name  status       Parameters       name     in path    string  required    name of the StatefulSet       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    StatefulSet  a    OK  201   a href    StatefulSet  a    Created  401  Unauthorized        delete  delete a StatefulSet       HTTP Request  DELETE  apis apps v1 namespaces  namespace  statefulsets  name        Parameters       name     in path    string  required    name of the StatefulSet       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 StatefulSet       HTTP Request  DELETE  apis apps v1 namespaces  namespace  statefulsets       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