Help Center> Cloud Container Engine> API Reference> Kubernetes APIs> Deployment> Updating the Scaling Operation of a Specified Deployment
View PDF

Updating the Scaling Operation of a Specified Deployment

Function

This API is used to partially update scale of the specified Scale.

The following fields can be updated:

  • metadata.resourceVersion
  • metadata.creationTimestamp
  • spec.replicas

URI

PATCH /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale (for clusters of v1.9 and later)

PATCH /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/scale (for clusters of v1.15 and earlier)

Table 1 describes the parameters of this API.

Table 1 Parameter description

Parameter

Mandatory

Description

name

Yes

Name of the Scale.

namespace

Yes

Object name and auth scope, such as for teams and projects.

pretty

No

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

Request

Request parameters:

For the description about the Content-Type field, see Patch Request Method Operation Description.

Example request:

Content-Type: application/json-patch+json    # Parameters in the request header
# The following is the request body.
[
    {
        "op": "add",
        "path": "/spec/replicas",
        "value": 2
    }
]

Response

Response parameters:

For the description about response parameters, see Table 2.

Example response:

{
    "kind": "Scale",
    "apiVersion": "extensions/v1beta1",
    "metadata": {
        "name": "deploy-ex-12130306",
        "namespace": "ns-12130306-s",
        "selfLink": "/apis/extensions/v1beta1/namespaces/ns-12130306-s/deployments/deploy-ex-12130306/scale",
        "uid": "934db57d-dfb3-11e7-9c19-fa163e2d897b",
        "resourceVersion": "418857",
        "creationTimestamp": "2017-12-13T03:13:22Z"
    },
    "spec": {
        "replicas": 2
    },
    "status": {
        "replicas": 1,
        "selector": {
            "cce/appgroup": "deploy-ex-test"
        },
        "targetSelector": "cce/appgroup=deploy-ex-test"
    }
}

Status Code

Table 2 describes the status code of this API.

Table 2 Status code

Status Code

Description

200

This operation succeeds, and a Deployment resource object is returned.

For the description about error status codes, see Status Code.

Parent topic: Deployment