getAutoScalingGroupList

VPC環境で利用できます。

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

構文

getAutoScalingGroupList構文は次の通りです。

./ncloud vautoscaling getAutoScalingGroupList \
    [--autoScalingGroupNoList <auto-scaling-group-no-list>] \
    [--autoScalingGroupNameList <auto-scaling-group-name-list>] \
    [--pageNo <page-no>] \
    [--pageSize <page-size>] \
    [--sortList <sort-condition>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

オプション

getAutoScalingGroupListの実行時に指定できるオプションについて説明します。

必須オプション

getAutoScalingGroupListの必須オプションです。

オプション	タイプ	必須の有無	説明
`--pageSize`	Integer	Conditional	ページごとの項目数 `1`~N `pageNo`入力時、必ず入力

任意オプション

getAutoScalingGroupListの任意オプションです。指定しない場合、オプションにはデフォルト値が適用されます。

オプション	タイプ	必須の有無	説明
`--autoScalingGroupNoList`	List	Optional	Auto Scaling Group番号リストスペースで区切って複数入力可能 (例: `--autoScalingGroupNoList 1234 2345`)
`--autoScalingGroupNameList`	List	Optional	Auto Scaling Group名リストスペースで区切って複数入力可能 (例: `--autoScalingGroupNameList test1 test2`)
`--pageNo`	Integer	Optional	ページ番号 `1`~N
`--sortList`	List	Optional	ソートの条件二重引用符の中に{フィールド=‘値’}のペアをコンマで区切って入力 `sortedBy` (任意): ソート対象。有効な値: `autoScalingGroupName` (Auto Scaling Group名) `sortingOrder` (任意): ソート順序。`ASC` (上昇、デフォルト) \| `DESC` (下降)

共通オプション

vautoscalingコマンドで共通して使用するオプションについては、Auto Scaling (VPC)のオプションをご参照ください。

例

Auto Scaling Groupリストの照会リクエストが成功すると、各 Auto Scaling Groupの構成情報が返されます。

コマンド

コマンドの例は次の通りです。

./ncloud vautoscaling getAutoScalingGroupList \
    --autoScalingGroupNoList 20461037 \
    --autoScalingGroupNameList asg-01 \
    --pageNo 0 \
    --pageSize 10 \
    --sortList "sortedBy='autoScalingGroupName',sortingOrder='ASC'" \
    --regionCode KR \
    --output json

出力

出力の例は次の通りです。

{
    "getAutoScalingGroupListResponse": {
        "totalRows": 1,
        "autoScalingGroupList": [
            {
                "vpcNo": "12345678",
                "subnetNo": "23456789",
                "serverNamePrefix": "test",
                "autoScalingGroupNo": "20461037",
                "autoScalingGroupName": "asg-01",
                "launchConfigurationNo": "18305791",
                "minSize": 0,
                "maxSize": 0,
                "desiredCapacity": 0,
                "defaultCoolDown": 300,
                "healthCheckGracePeriod": 300,
                "healthCheckType": {
                    "code": "SVR",
                    "codeName": "サーバ"
                },
                "createDate": "2026-07-07T10:22:20+0900",
                "autoScalingGroupStatus": {
                    "code": "CREAT",
                    "codeName": "Created"
                },
                "targetGroupNoList": [],
                "inAutoScalingGroupServerInstanceList": [],
                "accessControlGroupNoList": [
                    "67890123"
                ],
                "suspendedProcessList": []
            }
        ],
        "requestId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
        "returnCode": "0",
        "returnMessage": "success"
    }
}