本文へジャンプします。

ニフクラ APIリファレンス

NiftyDescribeAutoScalingGroups

処理概要

指定したオートスケールの定義情報を取得します。
オートスケールを指定するためには、オートスケール名が必要です。
オートスケールを指定しない場合、取得できるすべてのオートスケールの定義情報を取得します。

指定するパラメーター

パラメーター 説明 必須 サンプル値
AutoScalingGroupName.n オートスケール名
Type : String
使用可能な文字 : 半角英数字(1〜15文字)
  auto001

応答フィールド

フィールド 説明 サンプル値
NiftyDescribeAutoScalingGroupsResponse NiftyDescribeAutoScalingGroupsレスポンス
Type : NiftyDescribeAutoScalingGroupsResponseType
Ancestor : なし
Children : requestId, autoScalingReservationSet
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : NiftyDescribeAutoScalingGroupsResponse
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c
autoScalingReservationSet 取得したオートスケール情報セット
Type : AutoScalingReservationSetType
Ancestor : NiftyDescribeAutoScalingGroupsResponse
Children : item
 
item オートスケール情報
Type : AutoScalingReservationInfoType
Ancestor : autoScalingReservationSet
Children : autoScalingGroupName,description,imageId,instanceType,groupSet,triggerSet,scaleoutCondition,loadBalancing,minSize,maxSize,instanceLifecycleLimit,scaleout,defaultCooldown,changeInCapacity,scheduleSet,placement,instancesSet,createdTime,alarm
 
autoScalingGroupName オートスケール名
Type : xsd:string
Ancestor : item
Children : なし
auto001
description メモ
Type : xsd:string
Ancestor : item
Children : なし
 
imageId イメージID
Type : xsd:string
Ancestor : item
Children : なし
 
instanceType サーバータイプ
Type : xsd:string
Ancestor : item
Children : なし
 
groupSet ファイアウォール情報セット
Type : GroupSetType
Ancestor : item
Children : item
 
item ファイアウォール情報
Type : GroupItemType
Ancestor : groupSet
Children : groupId
 
groupId ファイアウォールグループ名
Type : xsd:string
Ancestor : item
Children : なし
 
triggerSet トリガー情報セット
Type : TriggerSetType
Ancestor : item
Children : item
 
item トリガー情報
Type : TriggerItemType
Ancestor : triggerSet
Children : resource,upperThreshold,breachDuration
 
resource リソース
Type : sd:string
Ancestor : item
Children : なし
 
upperThreshold 条件「以上」の閾値
Type : xsd:double
Ancestor : item
Children : なし
 
breachDuration 長さ(秒)
Type : xsd:Integer
Ancestor : item
Children : なし
 
scaleoutCondition スケールアウトの条件
Type : xsd:string
Ancestor : item
Children : なし
 
loadBalancing ロードバランサー情報セット
Type : LoadBalancingSetType
Ancestor : item
Children : item
 
item ロードバランサー情報
Type : LoadBalancingItemType
Ancestor : loadBalancing
Children : loadBalancerName,loadBalancerPort,instancePort
 
loadBalancerName ロードバランサー名
Type : xsd:string
Ancestor : item
Children : なし
 
loadBalancerPort 待ち受けポート
Type : xsd:integer
Ancestor : item
Children : なし
 
instancePort 宛先ポート
Type : xsd:integer
Ancestor : item
Children : なし
 
minSize スケールアウトするサーバーの最小台数
Type : xsd:integer
Ancestor : item
Children : なし
 
maxSize スケールアウトするサーバーの最大台数
Type : xsd:integer
Ancestor : item
Children : なし
 
instanceLifecycleLimit スケールアウトサーバーの有効時間(秒)
Type : xsd:integer
Ancestor : item
Children : なし
 
scaleout スケールアウト開始間隔(秒)
Type : xsd:integer
Ancestor : item
Children : なし
 
defaultCooldown 縮退開始間隔(秒)
Type : xsd:integer
Ancestor : item
Children : なし
 
changeInCapacity スケールアウト/縮退台数
Type : xsd:integer
Ancestor : item
Children : なし
 
scheduleSet スケジュール情報セット
Type : ScheduleSetType
Ancestor : item
Children : item
 
item スケジュール情報
Type : ScheduleItemType
Ancestor : scheduleSet
Children : timeZone,day,dDay,month
 
timeZone スケールアウトを有効にする時間帯
Type : ScalingScheduleTimeZoneType
Ancestor : item
Children : startingTimeZone,endingTimeZone
 
startingTimeZone 開始時間帯
Type : xsd:string
Ancestor : timeZone
Children : なし
 
endingTimeZone 終了時間帯
Type : xsd:string
Ancestor : timeZone
Children : なし
 
day スケールアウトを有効にする曜日
Type : ScalingScheduleDayType
Ancestor : item
Children : setSunday,setMonday,setTuesday,setWednesday,setThursday,setFriday,setSaturday
 
setSunday 日曜日の設定
Type : xsd:string
値: 0 (無効) | 1 (有効)
Ancestor : day
Children : なし
 
setMonday 月曜日の設定
Type : xsd:string
値: 0 (無効) | 1 (有効)
Ancestor : day
Children : なし
 
setTuesday 火曜日の設定
Type : xsd:string
値: 0 (無効) | 1 (有効)
Ancestor : day
Children : なし
 
setWednesday 水曜日の設定
Type : xsd:string
値: 0 (無効) | 1 (有効)
Ancestor : day
Children : なし
 
setThursday 木曜日の設定
Type : xsd:string
値: 0 (無効) | 1 (有効)
Ancestor : day
Children : なし
 
setFriday 金曜日の設定
Type : xsd:string
値: 0 (無効) | 1 (有効)
Ancestor : day
Children : なし
 
setSaturday 土曜日の設定
Type : xsd:string
値: 0 (無効) | 1 (有効)
Ancestor : day
Children : なし
 
dDay スケールアウトを有効にする月内日
Type : ScalingScheduleDDayType
Ancestor : item
Children : startingDDay,endingDDay
 
startingDDay 月内開始日
Type : xsd:string
Ancestor : dDay
Children : なし
 
endingDDay 月内終了日
Type : xsd:string
Ancestor : dDay
Children : なし
 
month スケールアウトを有効にする月
Type : ScalingScheduleMonthType
Ancestor : item
Children : startingMonth,endingMonth
 
startingMonth 開始月
Type : xsd:string
Ancestor : month
Children : なし
 
endingMonth 終了月
Type : xsd:string
Ancestor : month
Children : なし
 
placement ゾーン情報
Type : PlacementSetType
Ancestor : item
Children : availabilityZone
 
availabilityZone ゾーン名
Type : xsd:string
Ancestor : placement
Children : なし
 
instancesSet スケールアウトサーバー情報セット
Type : AutoScalingInstancesSetType
Ancestor : item
Children : item
 
item スケールアウトサーバー情報
Type : AutoScalingInstancesItemType
Ancestor : instancesSet
Children : instanceId, instanceUniqueId ,instanceState,dnsName,instanceType,expireTime
 
instanceId サーバー名
Type : xsd:string
Ancestor : item
Children : なし
 
instanceUniqueId サーバーのユニークID
Type : xsd:string
Ancestor : item
Children : なし
 
instanceState サーバーステータス
Type : InstanceStateType
Ancestor : item
Children : code,name
 
code ステータスコード
Type : xsd:integer
Ancestor : instanceState
Children : なし
 
name ステータス名
Type : xsd:string
Ancestor : instanceState
Children : なし
 
dnsName グローバルIPアドレス
Type : xsd:string
Ancestor : item
Children : なし
 
instanceType サーバータイプ
Type : xsd:string
Ancestor : item
Children : なし
 
expireTime 有効時間
Type : xsd:datetime (yyyy-mm-ddThh:mm:ssZ)
Ancestor : item
Children : なし
 
createdTime オートスケール設定の作成日時
Type : xsd:datetime(yyyy-mm-ddThh:mm:ssZ)
Ancestor : item
Children : なし
 
alarm アラーム状態
Type : xsd:string
値: 0(正常) | 1(スケールアウト中) | 2(縮退中)
Ancestor : item
Children : なし
 

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=NiftyDescribeAutoScalingGroups&CommonParams

応答サンプル

< NiftyDescribeAutoScalingGroupsResponse xmlns="https://cp.cloud.nifty.com/api/">
 <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
 <autoScalingReservationSet>
  <item>
   <autoScalingGroupName>1126AutoScale</autoScalingGroupName>
   <description>memo</description>
   <imageId>255</imageId>
   <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>

ニフティクラウド サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ

推奨画面サイズ 1024×768 以上