getAutoScalingGroupList

VPC環境で利用できます。

Auto Scaling Groupリストを照会します。

リクエスト

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

メソッド	URI
GET \| POST	/vautoscaling/v2/getAutoScalingGroupList

参考

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	リージョンコード getRegionListを参照照会結果の最初のリージョン(デフォルト)
`autoScalingGroupNoList.N`	Array	Optional	Auto Scaling Group番号リスト Auto Scaling Group番号で絞り込み <例> `autoScalingGroupNoList.1=1234&autoScalingGroupNoList.2=2345`
`autoScalingGroupNameList.N`	Array	Optional	Auto Scaling Group名リスト Auto Scaling Group名で絞り込み <例> `autoScalingGroupNameList.1=test1&autoScalingGroupNameList.2=test2`
`pageNo`	Integer	Optional	ページ番号 1~N
`pageSize`	Integer	Conditional	ページごとの項目数 1~N `pageNo`入力時、必ず入力
`sortList.N.sortedBy`	String	Optional	ソート対象 `autoScalingGroupName`: Auto Scaling Group名 (有効値) <例> `sortList.1.sortedBy=autoScalingGroupName`
`sortList.N.sortingOrder`	String	Optional	ソート順序 `ASC` (デフォルト) \| `DESC` `ASC`: 昇順 `DESC`: 降順
`responseFormatType`	String	Optional	レスポンスデータの形式 `xml`(デフォルト) \| `json`

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vautoscaling/v2/getAutoScalingGroupList
?regionCode=KR
&autoScalingGroupNameList.1=asg
&autoScalingGroupNameList.2=source
&pageNo=1
&pageSize=10
&sortList.1.sortedBy=autoScalingGroupName
&sortList.1.sortingOrder=DESC
&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}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
  "getAutoScalingGroupListResponse": {
    "totalRows": 2,
    "autoScalingGroupList": [
      {
        "vpcNo": "4**5",
        "subnetNo": "3***4",
        "serverNamePrefix": "",
        "autoScalingGroupNo": "1***0",
        "autoScalingGroupName": "as19762e1ddd2",
        "launchConfigurationNo": "5891",
        "minSize": 0,
        "maxSize": 10,
        "desiredCapacity": 0,
        "defaultCoolDown": 300,
        "healthCheckGracePeriod": 300,
        "healthCheckType": {
          "code": "SVR",
          "codeName": "Server"
        },
        "createDate": "2025-06-17T15:44:19+0900",
        "autoScalingGroupStatus": {
          "code": "CREAT",
          "codeName": "Created"
        },
        "targetGroupNoList": [],
        "inAutoScalingGroupServerInstanceList": [],
        "accessControlGroupNoList": [
          "1***1"
        ],
        "suspendedProcessList": []
      },
      {
        "vpcNo": "4**5",
        "subnetNo": "3***4",
        "serverNamePrefix": "",
        "autoScalingGroupNo": "1***2",
        "autoScalingGroupName": "test-asg-80581",
        "launchConfigurationNo": "5891",
        "minSize": 1,
        "maxSize": 3,
        "desiredCapacity": 1,
        "defaultCoolDown": 300,
        "healthCheckGracePeriod": 300,
        "healthCheckType": {
          "code": "LOADB",
          "codeName": "ロードバランサ"
        },
        "createDate": "2025-05-16T10:39:23+0900",
        "autoScalingGroupStatus": {
          "code": "CREAT",
          "codeName": "Created"
        },
        "targetGroupNoList": [
          "414714"
        ],
        "inAutoScalingGroupServerInstanceList": [
          {
            "serverInstanceNo": "10*****61",
            "healthStatus": {
              "code": "HLTHY",
              "codeName": "正常"
            },
            "lifecycleState": {
              "code": "INSVC",
              "codeName": "サービス提供中"
            }
          }
        ],
        "accessControlGroupNoList": [
          "1***1"
        ],
        "suspendedProcessList": [
          {
            "process": {
              "code": "ADTLB",
              "codeName": "サーバインスタンスをロードバランサに追加"
            },
            "suspensionReason": "User suspended at 2025-05-16 10:39:23.31694776"
          },
          {
            "process": {
              "code": "ALMNO",
              "codeName": "アラーム通知"
            },
            "suspensionReason": "User suspended at 2025-05-16 10:39:23.31694776"
          },
          {
            "process": {
              "code": "SCACT",
              "codeName": "スケジュールされたアクション"
            },
            "suspensionReason": "User suspended at 2025-05-16 10:39:23.31694776"
          }
        ]
      }
    ],
    "requestId": "c8efabf2-****-****-****-303b4009e362",
    "returnCode": "0",
    "returnMessage": "success"
  }
}