getAutoScalingGroupList

Article summary

Did you find this summary helpful?

Thank you for your feedback

Overview

Get Auto Scaling Group List

Description

Present detailed descriptions regarding scaling groups in the form of a list.
If the name of Auto Scaling Group is not assigned, receive detailed descriptions of every Auto Scaling Group.
If the name is assigned, receive descriptions of the assigned one only.
The list can also be divided into pages. A user can assign each page size(item number) and page number.

Request Parameters

Parameter	Required	Type	Restrictions	Description
autoScalingGroupNameList	No	List	Min : 1, Max : 255	Enter a list of autoscaling group names to be viewed. If you do not enter an auto scaling group name, all the lists created in the account are displayed. If you enter a list of auto scaling group names, only the list corresponding to the requested auto scaling is displayed.
pageNo	No	Integer	Min : 0, Max : 2147483647	Enter the page information of the Pagination in the list view. If you enter a default value of 0, all lists are displayed.
pageSize	No	Integer	Min : 0, Max : 2147 w483647	Enter the number of pieces of information to be displayed in the Pagination in the list view. If you enter a default value of 0, all lists are queried.
sortedBy	No	String	-	Name of Auto Scaling Group(autoScalingGroupName) \| Date Created (createDate) [No case sensitivity] Default: Name of Auto Scaling Group(autoScalingGroupName)
sortingOrder	No	String	-	Ascending \| descending [No case sensitivity] Default: Ascending
regionNo	No	String		You can reach a state in which input is possible by calling getRegionList.

Response Data type

AutoScalingGroupList Type

AutoScalingGroupList extends CommonResponse
private Integer totalRows;
private List autoScalingGroupList = new ArrayList();

AutoScalingGroup extends BaseObject
private String autoScalingGroupName;
private String autoScalingGroupNo;
private String launchConfigurationName;
private String launchConfigurationNo;
private Integer desiredCapacity;
private Integer minSize;
private Integer maxSize;
private Integer defaultCooldown;
private List loadBalancerInstanceSummaryList;
private Integer healthCheckGracePeriod;
private CommonCode healthCheckType;
private Date createDate;
private List inAutoScalingGroupServerInstanceList;
private List suspendedProcessList;
private List zoneList;

LoadBalancerInstanceSummary extends BaseObject
private String loadBalancerInstanceNo;
private String loadBalancerName;

InAutoScalingGroupServerInstance extends BaseObject
private CommonCode healthStatus;
private CommonCode lifecycleState;
private LaunchConfiguration launchConfiguration;
private String serverInstanceNo;
private String serverInstanceName;

SuspendedProcess
private CommonCode process;
private String suspensionReason;

Zone
private String zoneNo;
private String zoneName;
private String zoneCode;
private String zoneDescription;
private String regionNo;
private long totalMemorySize;
private long totalUsedMemorySize;
private long totalUsePossibleMemorySize;

CommonCode
private String codeKind;
private String detailCategorizeCode;
private String code;
private String codeName;
private Integer codeOrder;
private String javaConstantCode;

LaunchConfiguration
private String launchConfigurationName;
private String launchConfigurationNo;
private String serverImageProductCode;
private String serverProductCode;
private String memberServerImageNo;
private String loginKeyName;
private Date createDate;
private String userData;
private List accessControlGroupList;

AccessControlGroup extends BaseObject
private String accessControlGroupConfigurationNo;
private String accessControlGroupName;
private String accessControlGroupDescription;
private boolean isDefault;
private Date createDate;

Examples

Request

ncloud autoscaling getAutoScalingGroupList --autoScalingGroupNameList vbewr

Response

{
  "getAutoScalingGroupListResponse": {
    "requestId": "f29ae8d9-cf23-48ca-ae0f-cb8179595665",
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 1,
    "autoScalingGroupList": [
      {
        "autoScalingGroupName": "vbewr",
        "autoScalingGroupNo": "***517",
        "launchConfigurationName": "lctest01",
        "launchConfigurationNo": "***013",
        "desiredCapacity": 0,
        "minSize": 0,
        "maxSize": 0,
        "defaultCooldown": 300,
        "loadBalancerInstanceSummaryList": [],
        "healthCheckGracePeriod": 300,
        "healthCheckType": {
          "code": "SVR",
          "codeName": "Server"
        },
        "createDate": "2017-12-22T11:26:19+0900",
        "inAutoScalingGroupServerInstanceList": [],
        "suspendedProcessList": [],
        "zoneList": [
          {
            "zoneNo": "2",
            "zoneName": "KR-1",
            "zoneCode": "KR-1",
            "zoneDescription": "KR-1 zone",
            "regionNo": "1"
          }
        ]
      }
    ]
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<getAutoScalingGroupListResponse>
  <requestId>f29ae8d9-cf23-48ca-ae0f-cb8179595665</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <autoScalingGroupList>
    <autoScalingGroupName>vbewr</autoScalingGroupName>
    <autoScalingGroupNo>***517</autoScalingGroupNo>
    <launchConfigurationName>lctest01</launchConfigurationName>
    <launchConfigurationNo>***013</launchConfigurationNo>
    <desiredCapacity>0</desiredCapacity>
    <minSize>0</minSize>
    <maxSize>0</maxSize>
    <defaultCooldown>300</defaultCooldown>
    <loadBalancerInstanceSummaryList/>
    <healthCheckGracePeriod>300</healthCheckGracePeriod>
    <healthCheckType>
      <code>SVR</code>
      <codeName>Server</codeName>
    </healthCheckType>
    <createDate>2017-12-22T11:26:19+0900</createDate>
    <inAutoScalingGroupServerInstanceList/>
    <suspendedProcessList/>
    <zoneList>
      <zoneNo>2</zoneNo>
      <zoneName>KR-1</zoneName>
      <zoneCode>KR-1</zoneCode>
      <zoneDescription>KR-1 zone</zoneDescription>
      <regionNo>1</regionNo>
    </zoneList>
  </autoScalingGroupList>
</getAutoScalingGroupListResponse>

Was this article helpful?

What's Next

createAutoScalingGroup

Table of contents

Overview
Description
Request Parameters
Response Data type
Examples