getAutoScalingGroupDetail

Prev Next

Available in VPC

Get Auto Scaling Group details.

Request

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

Method URI
GET | POST /vautoscaling/v2/getAutoScalingGroupDetail
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
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/getAutoScalingGroupDetail
?regionCode=KR
&autoScalingGroupNo=1***9
&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
getAutoScalingGroupDetailResponse Object - Response result
getAutoScalingGroupDetailResponse.requestId String - ID for the request
  • UUID format
getAutoScalingGroupDetailResponse.returnCode String - Response code
getAutoScalingGroupDetailResponse.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:

{
    "getAutoScalingGroupDetailResponse": {
        "totalRows": 1,
        "autoScalingGroupList": [
            {
                "vpcNo": "4**5",
                "subnetNo": "3***4",
                "serverNamePrefix": "",
                "autoScalingGroupNo": "1***9",
                "autoScalingGroupName": "asg",
                "launchConfigurationNo": "5891",
                "minSize": 0,
                "maxSize": 2,
                "desiredCapacity": 1,
                "defaultCoolDown": 600,
                "healthCheckGracePeriod": 300,
                "healthCheckType": {
                    "code": "LOADB",
                    "codeName": "Load Balancer"
                },
                "createDate": "2025-05-15T09:50:55+0900",
                "autoScalingGroupStatus": {
                    "code": "CREAT",
                    "codeName": "Created"
                },
                "targetGroupNoList": [],
                "inAutoScalingGroupServerInstanceList": [
                    {
                        "serverInstanceNo": "10*****18",
                        "healthStatus": {
                            "code": "HLTHY",
                            "codeName": "Success"
                        },
                        "lifecycleState": {
                            "code": "PNDNG",
                            "codeName": "Waiting"
                        }
                    }
                ],
                "accessControlGroupNoList": [
                    "1***1"
                ],
                "suspendedProcessList": []
            }
        ],
        "requestId": "a043ef98-****-****-****-c8b2f077d997",
        "returnCode": "0",
        "returnMessage": "success"
    }
}