Function

This API is used to replace a specified StatefulSet.

The following fields can be updated:

• metadata.labels
• metadata.annotations

• spec.template
• spec.replicas
• spec.revisionHistoryLimit
• spec.progressDeadlineSeconds

The other fields cannot be updated.

URI

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

Request

Request parameters

For the description about request parameters, see Table 86.

Example request

Change the replica of the StatefulSet created in Creating a StatefulSet to 2.

{
    "apiVersion": "apps/v1",
    "kind": "StatefulSet",
    "metadata": {
        "name": "statefulset-test"
    },
    "spec": {
        "replicas": 2,
        "selector": {
            "matchLabels": {
                "app": "statefulset-test"
            }
        },
        "template": {
            "metadata": {
                "labels": {
                    "app": "statefulset-test"
                }
            },
            "spec": {
                "containers": [
                    {
                        "image": "*.*.*.*:20202/cci/redis:V1",
                        "name": "container-0",
                        "resources": {
                            "limits": {
                                "cpu": "500m",
                                "memory": "1024Mi"
                            },
                            "requests": {
                                "cpu": "500m",
                                "memory": "1024Mi"
                            }
                        }
                    }
                ],
                "imagePullSecrets": [
                    {
                        "name": "imagepull-secret"
                    }
                ]
            }
        }
    }
}

Response

Response parameters

For the description about response parameters, see Table 86.

Example response

{
  "kind": "StatefulSet",
  "apiVersion": "apps/v1",
  "metadata": {
    "name": "statefulset-test",
    "namespace": "namespace-test",
    "selfLink": "/apis/apps/v1/namespaces/namespace-test/statefulsets/statefulset-test",
    "uid": "f4a35f35-b011-11e8-b6ef-f898ef6c78b4",
    "resourceVersion": "5223616",
    "generation": 2,
    "creationTimestamp": "2018-09-04T07:13:00Z",
    "labels": {
      "app": "statefulset-test"
    },
    "enable": true
  },
  "spec": {
    "replicas": 2,
    "selector": {
      "matchLabels": {
        "app": "statefulset-test"
      }
    },
    "template": {
      "metadata": {
        "creationTimestamp": null,
        "labels": {
          "app": "statefulset-test"
        },
        "enable": true
      },
      "spec": {
        "containers": [
          {
            "name": "container-0",
            "image": "redis",
            "resources": {
              "limits": {
                "cpu": "500m",
                "memory": "1Gi"
              },
              "requests": {
                "cpu": "500m",
                "memory": "1Gi"
              }
            },
            "terminationMessagePath": "/dev/termination-log",
            "terminationMessagePolicy": "File",
            "imagePullPolicy": "IfNotPresent"
          }
        ],
        "restartPolicy": "Always",
        "terminationGracePeriodSeconds": 30,
        "dnsPolicy": "ClusterFirst",
        "securityContext": {

        },
        "imagePullSecrets": [
          {
            "name": "imagepull-secret"
          }
        ],
        "schedulerName": "default-scheduler"
      }
    },
    "serviceName": "",
    "podManagementPolicy": "OrderedReady",
    "updateStrategy": {
      "type": "OnDelete"
    },
    "revisionHistoryLimit": 10
  },
  "status": {
    "observedGeneration": 1,
    "replicas": 3,
    "readyReplicas": 1,
    "currentReplicas": 3,
    "currentRevision": "statefulset-test-f986b645b",
    "updateRevision": "statefulset-test-f986b645b",
    "collisionCount": 0
  }
}

Status Code

Table 3 describes the status code of this API.

For more status codes, see Status Codes.