getAutoScalingGroupList

Available in VPC

Get a list of Auto Scaling Groups.

Syntax

The getAutoScalingGroupList syntax is as follows:

./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>]

Options

This section describes the options available when running getAutoScalingGroupList.

Required options

The following options are required for getAutoScalingGroupList.

Options	Type	Required	Description
`--pageSize`	Integer	Conditional	Number of items per page `1`-N Required when entering `pageNo`

Optional options

These are the optional options for getAutoScalingGroupList. Options that are not specified will use their default values.

Options	Type	Required	Description
`--autoScalingGroupNoList`	List	Optional	Auto Scaling Group number list You can enter multiple items separated by spaces (e.g., `--autoScalingGroupNoList 1234 2345`).
`--autoScalingGroupNameList`	List	Optional	Auto Scaling Group name list You can enter multiple items separated by spaces (e.g., `--autoScalingGroupNameList test1 test2`).
`--pageNo`	Integer	Optional	Page number `1`-N
`--sortList`	List	Optional	Sort criteria Enter {field='value'} pairs enclosed in quotes and separated by commas. `sortedBy` (optional): Sort target. Valid values: `autoScalingGroupName` (Auto Scaling Group name). `sortingOrder` (optional): Sort order. `ASC` (ascending, default) \| `DESC` (descending).

Common options

For information on options commonly used in the vautoscaling command, see Auto Scaling (VPC) options.

Examples

If the request to retrieve the list of Auto Scaling Groups is successful, the configuration information for each Auto Scaling Group is returned.

Command

The command example is as follows:

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

Output

The output example is as follows:

{
    "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": "Server"
                },
                "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"
    }
}