getAutoScalingGroupList

VPC 환경에서 이용 가능합니다.

개요

Auto Scaling Group 리스트를 조회합니다.

요청

요청 파라미터

파라미터명	필수 여부	타입	제약 사항	설명
regionCode	No	String		- 리전 코드 Auto Scaling Group 리스트가 조회될 리전(Region) 결정 가능 regionCode는 getRegionList 액션을 통해 획득 가능 Default : getRegionList 조회 결과의 첫 번째 리전을 선택
autoScalingGroupNoList.N	No	List<String>		- Auto Scaling Group 번호 리스트 Auto Scaling Group 번호로 필터링하여 검색 가능 autoScalingGroupNo는 getAutoScalingGroupList 액션을 통해 획득 가능 ex) autoScalingGroupNoList.1=1234&autoScalingGroupNoList.2=2345
autoScalingGroupNameList.N	No	List<String>	Min : 1, Max : 255	- Auto Scaling Group 이름 리스트 Auto Scaling Group 이름으로 필터링하여 검색 가능 autoScalingGroupName는 getAutoScalingGroupList 액션을 통해 획득 가능 ex) autoScalingGroupNameList.1=test1&autoScalingGroupNameList.2=test2
pageNo	No	Integer		- 페이징된 결과의 페이지 번호 결과값을 pageNo, pageSize를 이용하여 페이징 처리 가능
pageSize	Conditional	Integer		- 페이징 시 보여줄 각 페이지 사이즈 결과값을 pageNo, pageSize를 이용하여 페이징 처리 가능 pageNo 입력시 반드시 입력함
sortList.N.sortedBy	No	String		- 정렬 대상 결과값을 Auto Scaling Group 이름으로 정렬 가능 Options : autoScalingGroupName ex) sortList.1.sortedBy=autoScalingGroupName
sortList.N.sortingOrder	No	String		- 정렬 순서 sortedBy 이용시 오름차순/내림차순 정렬을 설정함 Options : ASC (오름차순) \| DESC (내림차순) Default : ASC ex) sortList.1.sortingOrder=DESC
responseFormatType	No	String		- 응답 결과의 포맷 타입 Options : xml \| json Default : xml

응답

응답 데이터 타입

AutoScalingGroupList 타입

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;

예시

요청 예시

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

응답 예시

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

Documentation Index

getAutoScalingGroupList

개요

요청

요청 파라미터

응답

응답 데이터 타입

예시

요청 예시

응답 예시