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 |
|---|
| 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 |
| private AccessControlGroupNoList accessControlGroupNoList; |
| private List |
| TargetGroupNoList |
|---|
| private List |
| InAutoScalingGroupServerInstance |
|---|
| private String serverInstanceNo; |
| private CommonCode healthStatus; |
| private CommonCode lifecycleState; |
| AccessControlGroupNoList |
|---|
| private List |
| 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>