setDesiredCapacity

Prev Next

Available in VPC

Change the expected capacity of Auto Scaling Group.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET | POST /vautoscaling/v2/setDesiredCapacity
Note

This guide is based on the GET method. POST method call tests can be performed through Swagger in the API Gateway service of the NAVER Cloud Platform console.

Request headers

For information about the headers common to all Auto Scaling APIs, see Auto Scaling request headers.

Request query parameters

You can use the following query parameters with your request:

Field Type Required Description
regionCode String Optional Region code
autoScalingGroupNo String Required Auto Scaling Group number
desiredCapacity Integer Required Expected capacity
  • 0-30
  • Set to minimum capacity (minSize) or more, maximum capacity (maxSize) or less.
  • Automatically adjust the number of servers based on the input value.
responseFormatType String Optional Format of the response data
  • xml (default) | json

Request example

The request example is as follows:

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vautoscaling/v2/setDesiredCapacity
?regionCode=KR
&autoScalingGroupNo=1***9
&desiredCapacity=1
&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
setDesiredCapacityResponse Object - Response result
setDesiredCapacityResponse.requestId String - ID for the request
  • UUID format
setDesiredCapacityResponse.returnCode String - Response code
setDesiredCapacityResponse.returnMessage String - Response message

Response status codes

For response status codes common to all Auto Scaling APIs, see Auto Scaling response status codes.

Response example

The response example is as follows:

{
    "setDesiredCapacityResponse": {
        "totalRows": 1,
        "autoScalingGroupList": [
            {
                "vpcNo": "4**5",
                "subnetNo": "3***4",
                "serverNamePrefix": "",
                "autoScalingGroupNo": "1***9",
                "autoScalingGroupName": "asg",
                "launchConfigurationNo": "5891",
                "minSize": 0,
                "maxSize": 2,
                "desiredCapacity": 1,
                "defaultCoolDown": 300,
                "healthCheckGracePeriod": 300,
                "healthCheckType": {
                    "code": "LOADB",
                    "codeName": "Load Balancer"
                },
                "createDate": "2025-05-15T09:50:55+0900",
                "autoScalingGroupStatus": {
                    "code": "CREAT",
                    "codeName": "Created"
                },
                "targetGroupNoList": [],
                "inAutoScalingGroupServerInstanceList": [],
                "accessControlGroupNoList": [
                    "1***1"
                ],
                "suspendedProcessList": []
            }
        ],
        "requestId": "e18484ff-****-****-****-b2d212d9c5e6",
        "returnCode": "0",
        "returnMessage": "success"
    }
}