getAutoScalingGroupDetail

Prev Next

VPC環境で利用できます。

Auto Scaling Groupの詳細情報を照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET | POST /vautoscaling/v2/getAutoScalingGroupDetail
参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

Auto Scaling APIで共通して使用されるヘッダの詳細は、Auto Scalingのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
autoScalingGroupNo String Required Auto Scaling Group番号
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

リクエストのサンプルコードは次の通りです。

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}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
getAutoScalingGroupDetailResponse Object - レスポンス結果
getAutoScalingGroupDetailResponse.requestId String - リクエスト ID
  • UUID形式
getAutoScalingGroupDetailResponse.returnCode String - レスポンスコード
getAutoScalingGroupDetailResponse.returnMessage String - レスポンスメッセージ

レスポンスステータスコード

Auto Scaling APIで共通して使用されるレスポンスステータスコードの詳細は、Auto Scalingのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "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": "ロードバランサ"
                },
                "createDate": "2025-05-15T09:50:55+0900",
                "autoScalingGroupStatus": {
                    "code": "CREAT",
                    "codeName": "Created"
                },
                "targetGroupNoList": [],
                "inAutoScalingGroupServerInstanceList": [
                    {
                        "serverInstanceNo": "10*****18",
                        "healthStatus": {
                            "code": "HLTHY",
                            "codeName": "正常"
                        },
                        "lifecycleState": {
                            "code": "PNDNG",
                            "codeName": "待機中"
                        }
                    }
                ],
                "accessControlGroupNoList": [
                    "1***1"
                ],
                "suspendedProcessList": []
            }
        ],
        "requestId": "a043ef98-****-****-****-c8b2f077d997",
        "returnCode": "0",
        "returnMessage": "success"
    }
}