Available in VPC
Suspend the process of Auto Scaling Group.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
GET | POST | /vautoscaling/v2/suspendProcesses |
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 |
scalingProcessCodeList.N |
Array | Required | Process code list
|
responseFormatType |
String | Optional | Format of the response data
|
Request example
The request example is as follows:
curl --location --request GET 'https://ncloud.apigw.ntruss.com/vautoscaling/v2/suspendProcesses
?regionCode=KR
&autoScalingGroupNo=1***9
&scalingProcessCodeList.1=SCACT
&scalingProcessCodeList.2=RPUNH
&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 |
---|---|---|---|
suspendProcessesResponse |
Object | - | Response result
|
suspendProcessesResponse.requestId |
String | - | ID for the request
|
suspendProcessesResponse.returnCode |
String | - | Response code |
suspendProcessesResponse.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:
{
"suspendProcessesResponse": {
"processList": [
{
"code": "SCACT",
"codeName": "Scheduled action"
},
{
"code": "RPUNH",
"codeName": "Replace a server instance with health issues"
}
],
"requestId": "c9562c69-****-****-****-e0c14539d901",
"returnCode": "0",
"returnMessage": "success"
}
}