getAutoScalingGroupList

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

概要

Auto Scaling Groupリスト照会

説明

Auto Scaling Groupに対する説明をリストの形で伝達します。Auto Scaling Group名が指定されてない場合はユーザーが保有するすべてのAuto Scaling Groupに対する説明をリストで受け取り、指定されている場合は指定されたAuto Scaling Groupの説明をリストで受け取ります。

リクエストパラメータ

パラメータ名	必須	タイプ	制約事項	説明
autoScalingGroupNameList	No	List	Min : 1, Max : 255	照会するAuto Scaling Group名のリストを入力します。 Auto Scaling Group名を入力しない場合、アカウント内で作成されたすべてのリストが表示されます。 Auto Scaling Group名リストを入力すると、リクエストしたAuto Scalingに該当されるリストのみが表示されます。
pageNo	No	Integer	Min:0, Max:2147483647	リストを照会する時、Paginationのページ情報を入力します。基本値の0を入力した場合、すべてのリストを照会します。
pageSize	No	Integer	Min:0, Max:2147483647	リストを照会する時、Paginationに表示される情報の個数を入力します。基本値の0を入力した場合、すべてのリストを照会します。
sortedBy	No	String	-	Auto Scaling Group名(autoScalingGroupName) \| 作成日時(createDate) [大小文字区分なし] Default: Auto Scaling Group名(autoScalingGroupName)
sortingOrder	No	String	-	アセンディング(asceding) \| ディセンディング(descending) [大小文字区分なし] Default: アセンディング(asceding)
regionNo	No	String		入力できるステータスはgetRegionListアクションを通じて取得できます。

レスポンスデータタイプ

AutoScalingGroupListタイプ

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

AutoScalingGroup extends BaseObject
private String autoScalingGroupName;
private String launchConfigurationName;
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 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;

例示

呼び出し

ncloud autoscaling getAutoScalingGroupList --autoScalingGroupNameList vbewr

レスポンス

{
  "getAutoScalingGroupListResponse": {
    "requestId": "f29ae8d9-cf23-48ca-ae0f-cb8179595665",
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 1,
    "autoScalingGroupList": [
      {
        "autoScalingGroupName": "vbewr",
        "launchConfigurationName": "lctest01",
        "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>
    <launchConfigurationName>lctest01</launchConfigurationName>
    <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>

この記事は役に立ちましたか?

What's Next

createAutoScalingGroup

概要
説明
リクエストパラメータ
レスポンスデータタイプ
例示

タグ

Auto Scaling