スケーリンググループの照会

説明

この操作では、スケーリンググループの情報を照会します。スケーリンググループのライフサイクルの状態を次に示します。

Active: この状態の場合、スケーリンググループは、スケーリングルール実行リクエストを受信し、スケーリングアクティビティをトリガーできます。
Inactive: この状態の場合、スケーリンググループは、スケーリングルール実行リクエストを受信しません。
Deleting: スケーリンググループは、削除中で、スケーリングルール実行リクエストを受信しません。

リクエストパラメーター

名前	型	必須かどうか	説明
Action	String	はい	操作インターフェイス名、必須パラメーター。値: DescribeScalingGroups。
RegionId	String	はい	スケーリンググループが存在するリージョンの ID。
ScalingGroupId.N	String	いいえ	スケーリンググループ ID。最大 20 個の ID を入力できます。無効なスケーリンググループ ID は、クエリ結果に表示されず、エラーは報告されません。
ScalingGroupName.N	String	いいえ	スケーリンググループ名。最大 20 個の名前を入力できます。無効なスケーリンググループ名は、クエリ結果に表示されず、エラーは報告されません。
PageNumber	Integer	いいえ	スケーリンググループリストのページ番号 (1 から始まります)。デフォルト値: 1。
PageSize	Integer	いいえ	ページで照会する場合、このパラメーターは、ページあたりの行数を示します。最大値: 50。デフォルト値: 10。

リターンパラメーター

名前	型	説明
TotalCount	Integer	スケーリンググループの総数
PageNumber	Integer	現在のページ番号
PageSize	Integer	ページあたりの行数
ScalingGroups	ScalingGroupSetType	スケーリンググループ情報セット

ScalingGroupSetType は、ScalingGroupItemType のセットです。

名前	型	説明
ScalingGroup	ScalingGroupItemType	スケーリンググループ情報

ScalingGroupItemType の属性を次に示します。

名前	型	説明
ScalingGroupId	String	スケーリンググループ ID。
ScalingGroupName	String	表示されるスケーリンググループの名前。
ActiveScalingConfigurationId	String	スケーリンググループのアクティブなスケーリング設定の ID。
RegionId	String	スケーリンググループが存在するリージョンの ID。
MinSize	Integer	スケーリンググループの ECS インスタンスの最小数。
MaxSize	Integer	スケーリンググループの ECS インスタンスの最大数。
DefaultCooldown	Integer	スケーリンググループのデフォルトのクールダウン時間。
RemovalPolicies	RemovalPolicySetType	スケーリンググループから ECS インスタンスを削除する場合の一連のポリシー。
LoadBalancerId	String	Server Load Balancer インスタンスの ID。
DBInstanceIds	DBInstanceIdSetType	RDS インスタンスの ID。
VSwitchId	String	スケーリンググループに対応する仮想スイッチの ID。
LifecycleState	String	スケーリンググループのステータス。
TotalCapacity	Integer	スケーリンググループの ECS インスタンスの総数。
ActiveCapacity	Integer	スケーリンググループにアタッチされ、正常に実行中の ECS インスタンスの数。
PendingCapacity	Integer	関連する設定が未完了のスケーリンググループにアタッチされている ECS インスタンスの数。
RemovingCapacity	Integer	スケーリンググループから削除される ECS インスタンスの数。
CreationTime	String	スケーリンググループの作成時刻。

RemovalPolicySetType は、String 型のセットです。

名前	型	説明
RemovalPolicy	String	スケーリンググループから ECS インスタンスを削除する場合のポリシー。

DBInstanceIdSetType は、String 型のセットです。

名前	型	説明
DBInstanceId	String	RDS インスタンスの ID。

エラーコード

すべてのインターフェイスに共通のエラーについては、クライアントエラーコード表もしくはサーバーエラーコード表を参照してください。

例

リクエストの例

http://ess.aliyuncs.com/?Action=DescribeScalingGroups
&RegionId=cn-qingdao
&PageSize=50
&<Public Request Parameters>

戻り値の例

XML の例


<DescribeScalingGroupsResponse>
    <RequestId>6393C3A8-B611-42F2-AFA6-F080FC45D5D0</RequestId>
<TotalCount>1</TotalCount>
    <PageNumber>1</PageNumber>
    <PageSize>10</PageSize>
    <ScalingGroups> 
     <ScalingGroup>
            <ActiveCapacity>1</ActiveCapacity>         <ActiveScalingConfigurationId>
dyo713cNYIB4ddEVlKbcpOef
</ActiveScalingConfigurationId>
            <DBInstanceIds>
                <DBInstanceId>rdszzzyyunybaeu</DBInstanceId>
            </DBInstanceIds>
<VSwitchId>vpc-25j4god4l</VSwitchId>
            <DefaultCooldown>20</DefaultCooldown>
            <LifecycleState>Active</LifecycleState>
            <LoadBalancerId>147b46d767c-cn-qingdao-cm5-a01</LoadBalancerId>
            <MaxSize>1</MaxSize>
            <MinSize>0</MinSize>
            <PendingCapacity>0</PendingCapacity>
            <RegionId>cn-qingdao</RegionId>
            <RemovingCapacity>0</RemovingCapacity>
            <ScalingGroupId>dyrSuvBOtO1dEdIlIbplQb8</ScalingGroupId>
            <ScalingGroupName>dyrSuvBOtO1dEdIlIbplQb8</ScalingGroupName>
            <RemovalPolicies>
                <RemovalPolicy>OldestScalingConfiguration</RemovalPolicy>
                <RemovalPolicy>OldestInstance</RemovalPolicy>
            </RemovalPolicies>
            <TotalCapacity>1</TotalCapacity>
<CreationTime>2014-08-14T10:58Z</CreationTime>
        </ScalingGroup>
    </ScalingGroups>
</DescribeScalingGroupsResponse>

JSON 形式


{
 "RequestId": "68386699-8B9E-4D5B-BC4C-75A28F6C2A00",
"TotalCount": 1,
"PageSize": 10,
"PageNumber": 1,
  "ScalingGroups": {
    "ScalingGroup": [
      {
        "ScalingGroupId": "b8pYCVbIV5k9cz4PWpbe0k19",
        "ScalingGroupName": "b8pYCVbIV5k9cz4PWpbe0k19",
        "RegionId": "cn-qingdao",
        "RemovingCapacity": 0,
        "DefaultCooldown": 300,
        "MinSize": 1,
        "MaxSize": 2,
        "LifecycleState": "Inactive",
"ActiveScalingConfigurationId": " dyo713cNYIB4ddEVlKbcpOef",
        "LoadBalancerId": "147b46d767c-cn-qingdao-cm5-a01",
        "PendingCapacity": 0,
        "TotalCapacity": 0,
        "ActiveCapacity": 0,
"CreationTime": "2014-08-14T10:58Z",
"DBInstanceIds": {
          "DBInstanceId": [
            "rdsia3u3yia3u3y",
            "rdszzzyyunybaeu"
          ]
        },
        "VSwitchId":"vpc-25j4god4l",
        "RemovalPolicies": {
          "RemovalPolicy": [
            "OldestScalingConfiguration",
            "OldestInstance"
          ]
        }
      }
    ]
  }
 }