NiftyDescribeAutoScalingGroups
処理概要
指定したオートスケールの定義情報を取得します。
オートスケールを指定するためには、オートスケール名が必要です。
オートスケールを指定しない場合、取得できるすべてのオートスケールの定義情報を取得します。
指定するパラメーター
パラメーター | 型 | 説明 | 必須 |
---|---|---|---|
AutoScalingGroupName.n | string |
オートスケール名 使用可能文字: 半角英数字(1~15文字) |
応答フィールド
フィールド (項目) | 型 | 説明 |
---|---|---|
NiftyDescribeAutoScalingGroupsResponse | - |
NiftyDescribeAutoScalingGroupsレスポンス Ancestor: なし Children: requestId | autoScalingReservationSet |
requestId | string |
リクエスト識別子 Ancestor: NiftyDescribeAutoScalingGroupsResponse Children: なし |
autoScalingReservationSet | - |
取得したオートスケール情報セット Ancestor: NiftyDescribeAutoScalingGroupsResponse Children: item |
item | - |
オートスケール情報 Ancestor: autoScalingReservationSet Children: autoScalingGroupName | description | imageId | instanceType | groupSet | triggerSet | scaleoutCondition | loadBalancing | minSize | maxSize | instanceLifecycleLimit | scaleout | defaultCooldown | changeInCapacity | scheduleSet | placement | instancesSet | alarm | createdTime |
autoScalingGroupName | string |
オートスケール名 Ancestor: item Children: なし |
description | string |
メモ Ancestor: item Children: なし |
imageId | string |
イメージID Ancestor: item Children: なし |
instanceType | string |
サーバータイプ Ancestor: item Children: なし |
groupSet | - |
ファイアウォール情報セット Ancestor: item Children: item |
item | - |
ファイアウォール情報 Ancestor: groupSet Children: groupId |
groupId | string |
ファイアウォールグループ名 Ancestor: item Children: なし |
triggerSet | - |
トリガー情報セット Ancestor: item Children: item |
item | - |
トリガー情報 Ancestor: triggerSet Children: resource | upperThreshold | breachDuration |
resource | string |
リソース Ancestor: item Children: なし |
upperThreshold | double |
条件「以上」の閾値 Ancestor: item Children: なし |
breachDuration | integer |
長さ(秒) Ancestor: item Children: なし |
scaleoutCondition | string |
スケールアウトの条件 Ancestor: item Children: なし |
loadBalancing | - |
ロードバランサー情報セット Ancestor: item Children: item |
item | - |
ロードバランサー情報 Ancestor: loadBalancing Children: loadBalancerName | loadBalancerPort | instancePort |
loadBalancerName | string |
ロードバランサー名 Ancestor: item Children: なし |
loadBalancerPort | integer |
待ち受けポート Ancestor: item Children: なし |
instancePort | integer |
宛先ポート Ancestor: item Children: なし |
minSize | integer |
スケールアウトするサーバーの最小台数 Ancestor: item Children: なし |
maxSize | integer |
スケールアウトするサーバーの最大台数 Ancestor: item Children: なし |
instanceLifecycleLimit | integer |
スケールアウトサーバーの有効時間(秒) Ancestor: item Children: なし |
scaleout | integer |
スケールアウト開始間隔(秒) Ancestor: item Children: なし |
defaultCooldown | integer |
縮退開始間隔(秒) Ancestor: item Children: なし |
changeInCapacity | integer |
スケールアウト/縮退台数 Ancestor: item Children: なし |
scheduleSet | - |
スケジュール情報セット Ancestor: item Children: item |
item | - |
スケジュール情報 Ancestor: scheduleSet Children: timeZone | day | dDay | month |
timeZone | - |
スケールアウトを有効にする時間帯 Ancestor: item Children: startingTimeZone | endingTimeZone |
startingTimeZone | string |
開始時間帯 Ancestor: timeZone Children: なし |
endingTimeZone | string |
終了時間帯 Ancestor: timeZone Children: なし |
day | - |
スケールアウトを有効にする曜日 Ancestor: item Children: setSunday | setMonday | setTuesday | setWednesday | setThursday | setFriday | setSaturday |
setSunday | string |
日曜日の設定 値: 0(無効) | 1(有効) Ancestor: day Children: なし |
setMonday | string |
月曜日の設定 値: 0(無効) | 1(有効) Ancestor: day Children: なし |
setTuesday | string |
火曜日の設定 値: 0(無効) | 1(有効) Ancestor: day Children: なし |
setWednesday | string |
水曜日の設定 値: 0(無効) | 1(有効) Ancestor: day Children: なし |
setThursday | string |
木曜日の設定 値: 0(無効) | 1(有効) Ancestor: day Children: なし |
setFriday | string |
金曜日の設定 値: 0(無効) | 1(有効) Ancestor: day Children: なし |
setSaturday | string |
土曜日の設定 値: 0(無効) | 1(有効) Ancestor: day Children: なし |
dDay | - |
スケールアウトを有効にする月内日 Ancestor: item Children: startingDDay | endingDDay |
startingDDay | string |
月内開始日 Ancestor: dDay Children: なし |
endingDDay | string |
月内終了日 Ancestor: dDay Children: なし |
month | - |
スケールアウトを有効にする月 Ancestor: item Children: startingMonth | endingMonth |
startingMonth | string |
開始月 Ancestor: month Children: なし |
endingMonth | string |
終了月 Ancestor: month Children: なし |
placement | - |
ゾーン情報 Ancestor: item Children: availabilityZone |
availabilityZone | string |
ゾーン名 Ancestor: placement Children: なし |
instancesSet | - |
スケールアウトサーバー情報セット Ancestor: item Children: item |
item | - |
スケールアウトサーバー情報 Ancestor: instancesSet Children: instanceId | instanceUniqueId | instanceState | dnsName | instanceType | expireTime |
instanceId | string |
サーバー名 Ancestor: item Children: なし |
instanceUniqueId | string |
サーバーのユニークID Ancestor: item Children: なし |
instanceState | - |
サーバーステータス Ancestor: item Children: code | name |
code | integer |
ステータスコード Ancestor: instanceState Children: なし |
name | string |
ステータス名 Ancestor: instanceState Children: なし |
dnsName | string |
グローバルIPアドレス Ancestor: item Children: なし |
instanceType | string |
サーバータイプ Ancestor: item Children: なし |
expireTime | timestamp |
有効時間 表示形式: yyyy-mm-ddThh:mm:ssZ Ancestor: item Children: なし |
alarm | string |
アラーム状態 値: 0(正常) | 1(スケールアウト中) | 2(縮退中) Ancestor: item Children: なし |
createdTime | timestamp |
オートスケール設定の作成日時 表示形式: yyyy-mm-ddThh:mm:ssZ Ancestor: item Children: なし |
リクエストサンプル
https://jp-east-1.computing.api.nifcloud.com/api/
?Action=NiftyDescribeAutoScalingGroups
&CommonParams
応答サンプル
<NiftyDescribeAutoScalingGroupsResponse xmlns="https://computing.api.nifcloud.com/api/">
<requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
<autoScalingReservationSet>
<item>
<autoScalingGroupName>1126AutoScale</autoScalingGroupName>
<description>memo</description>
<imageId>255</imageId>
<instanceType>small4</instanceType>
<groupSet>
<item>
<groupId>1114restTestEx</groupId>
</item>
</groupSet>
<triggerSet>
<item>
<resource>2</resource>
<upperThreshold>90.0</upperThreshold>
<breachDuration>10</breachDuration>
</item>
</triggerSet>
<scaleoutCondition>1</scaleoutCondition>
<loadBalancing>
<item>
<loadBalancerName>afdsa</loadBalancerName>
<loadBalancerPort>80</loadBalancerPort>
<instancePort>80</instancePort>
</item>
</loadBalancing>
<minSize>1</minSize>
<maxSize>98</maxSize>
<instanceLifecycleLimit>30</instanceLifecycleLimit>
<scaleout>10</scaleout>
<defaultCooldown>30</defaultCooldown>
<changeInCapacity>1</changeInCapacity>
<scheduleSet>
<item>
<timeZone>
<startingTimeZone>1</startingTimeZone>
<endingTimeZone>24</endingTimeZone>
</timeZone>
<day>
<setSunday>1</setSunday>
<setMonday>1</setMonday>
<setTuesday>1</setTuesday>
<setWednesday>1</setWednesday>
<setThursday>1</setThursday>
<setFriday>1</setFriday>
<setSaturday>1</setSaturday>
</day>
<dDay>
<startingDDay>1</startingDDay>
<endingDDay>31</endingDDay>
</dDay>
<month>
<startingMonth>1</startingMonth>
<endingMonth>12</endingMonth>
</month>
</item>
</scheduleSet>
<placement>
<availabilityZone>zone_21</availabilityZone>
</placement>
<instancesSet>
<item>
<instanceId>image01_2</instanceId>
<instanceUniqueId>47621</instanceUniqueId>
<instanceState>
<code>16</code>
<name>running</name>
</instanceState>
<dnsName>124.25.69.150</dnsName>
<instanceType>small4</instanceType>
<expireTime>2015-02-13T14:18:55.000+09:00</expireTime>
</item>
</instancesSet>
<alarm>0</alarm>
<createdTime> 2015-02-13T09:17:02.000+09:00</createdTime>
</item>
</autoScalingReservationSet>
</NiftyDescribeAutoScalingGroupsResponse>