getAutoScalingGroupList
    • PDF

    getAutoScalingGroupList

    • PDF

    Article Summary

    Can be used in a VPC environment.

    Summary

    Search list of Auto Scaling Groups.

    Request

    Request Parameters

    Parameter nameRequirement statusTypeRestrictionsDescription
    regionCodeNoStringRegion 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.NNoList<String>List of Auto Scaling Group numbers
    You can search by filtering with an Auto Scaling Group number.
    autoScalingGroupNo can be obtained through the getAutoScalingGroupList action.
    ex) autoScalingGroupNoList.1=1234&autoScalingGroupNoList.2=2345
    autoScalingGroupNameList.NNoList<String>Min : 1, Max : 255List of Auto Scaling Group names
    You can search by filtering with an Auto Scaling Group name.
    autoScalingGroupName can be obtained through the getAutoScalingGroupList action.
    ex) autoScalingGroupNameList.1=test1&autoScalingGroupNameList.2=test2
    pageNoNoIntegerPage number of the paged results
    The results can be paged using pageNo and pageSize.
    pageSizeConditionalIntegerEach 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.sortedByNoStringSorted by
    You can sort the results by the Auto Scaling Group name.
    Options : autoScalingGroupName
    ex) sortList.1.sortedBy=autoScalingGroupName
    sortList.N.sortingOrderNoStringSorting order
    When using sortedBy, sort in ascending/descending order.
    Options: ASC (ascending order) | DESC (descending order)
    Default : ASC
    ex) sortList.1.sortingOrder=DESC
    responseFormatTypeNoStringFormat type of the response results
    Options : xml | json
    Default : xml

    Response

    Response body

    Example

    Request example

    GET {API_URL}/getAutoScalingGroupList
    ?regionCode=KR
    &autoScalingGroupNoList.1=***700
    &autoScalingGroupNameList.1=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>
    

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.