getAutoScalingGroupList

Prev Next

Can be used in a VPC environment.

Summary

Search list of Auto Scaling Groups.

Request

Request Parameters

Parameter name Requirement status Type Restrictions Description
regionCode No String Region code
You can decide the region where the list of Auto Scaling Groups will be searched.
You can obtain the regionCode through the getRegionList action.
Default: Select the first region of the getRegionList search results
autoScalingGroupNoList.N No List<String> List of Auto Scaling Group numbers
You can search by filtering with an Auto Scaling Group number.
You can obtain the autoScalingGroupNo through the getAutoScalingGroupList action.
ex) autoScalingGroupNoList.1=1234&autoScalingGroupNoList.2=2345
autoScalingGroupNameList.N No List<String> Min : 1, Max : 255 List of Auto Scaling Group names
You can search by filtering with an Auto Scaling Group name.
You can obtain the autoScalingGroupName through the getAutoScalingGroupList action.
ex) autoScalingGroupNameList.1=test1&autoScalingGroupNameList.2=test2
pageNo No Integer Page number of the paged results
The results can be paged using pageNo and pageSize.
pageSize Conditional Integer Each page size to be displayed when paging
The results can be paged using pageNo and pageSize.
You must enter it when entering pageNo.
sortList.N.sortedBy No String Sorted by
You can sort the results by the Auto Scaling Group name.
Options : autoScalingGroupName
ex) sortList.1.sortedBy=autoScalingGroupName
sortList.N.sortingOrder No String Sorting order
When using sortedBy, sort in ascending/descending order.
Options: ASC (ascending order) | DESC (descending order)
Default : ASC
ex) sortList.1.sortingOrder=DESC
responseFormatType No String Format type of the response results
Options : xml | json
Default : xml

Response

Response data type

  • AutoScalingGroupList type
AutoScalingGroupList extends CommonResponse
private Integer totalRows;
private List autoScalingGroup = new ArrayList<>();
AutoScalingGroup
private String vpcNo;
private String subnetNo;
private String serverNamePrefix;
private String autoScalingGroupNo;
private String autoScalingGroupName;
private String launchConfigurationNo;
private Integer minSize;
private Integer maxSize;
private Integer desiredCapacity;
private Integer defaultCoolDown;
private Integer healthCheckGracePeriod;
private CommonCode healthCheckType;
private Date createDate;
private CommonCode autoScalingGroupStatus;
private TargetGroupNoList targetGroupNoList;
private List inAutoScalingGroupServerInstanceList;
private AccessControlGroupNoList accessControlGroupNoList;
private List suspendedProcessList;
TargetGroupNoList
private List targetGroupNoList = new ArrayList<>();
InAutoScalingGroupServerInstance
private String serverInstanceNo;
private CommonCode healthStatus;
private CommonCode lifecycleState;
AccessControlGroupNoList
private List accessControlGroupNoList = new ArrayList<>();
SuspendedProcess
private CommonCode process;
private String suspensionReason;

Example

Request example

ncloud vautoscaling getAutoScalingGroupList --regionCode KR --autoScalingGroupNoList ***700 --autoScalingGroupNameList test-***

Response example

<getAutoScalingGroupListResponse>
  <requestId>0f416639-679c-4312-9da4-dbf1dac332a2</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <autoScalingGroupList>
    <autoScalingGroup>
      <vpcNo>***04</vpcNo>
      <subnetNo>***43</subnetNo>
      <serverNamePrefix></serverNamePrefix>
      <autoScalingGroupNo>***700</autoScalingGroupNo>
      <autoScalingGroupName>test-***</autoScalingGroupName>
      <launchConfigurationNo>***163</launchConfigurationNo>
      <minSize>0</minSize>
      <maxSize>0</maxSize>
      <desiredCapacity>0</desiredCapacity>
      <defaultCoolDown>300</defaultCoolDown>
      <healthCheckGracePeriod>300</healthCheckGracePeriod>
      <healthCheckType>
        <code>SVR</code>
        <codeName>Server</codeName>
      </healthCheckType>
      <createDate>2020-12-07T13:10:30+0900</createDate>
      <autoScalingGroupStatus>
        <code>CREAT</code>
        <codeName>Created</codeName>
      </autoScalingGroupStatus>
      <targetGroupNoList/>
      <inAutoScalingGroupServerInstanceList/>
      <accessControlGroupNoList>
        <accessControlGroupNo>***63</accessControlGroupNo>
      </accessControlGroupNoList>
      <suspendedProcessList/>
    </autoScalingGroup>
  </autoScalingGroupList>
</getAutoScalingGroupListResponse>