すべてのプロダクト
Search
ドキュメントセンター

Query a scaling group

最終更新日: Mar 18, 2020

説明

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

  • 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。

エラーコード

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

リクエストの例

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

戻り値の例

XML の例

  1. <DescribeScalingGroupsResponse>
  2. <RequestId>6393C3A8-B611-42F2-AFA6-F080FC45D5D0</RequestId>
  3. <TotalCount>1</TotalCount>
  4. <PageNumber>1</PageNumber>
  5. <PageSize>10</PageSize>
  6. <ScalingGroups>
  7. <ScalingGroup>
  8. <ActiveCapacity>1</ActiveCapacity> <ActiveScalingConfigurationId>
  9. dyo713cNYIB4ddEVlKbcpOef
  10. </ActiveScalingConfigurationId>
  11. <DBInstanceIds>
  12. <DBInstanceId>rdszzzyyunybaeu</DBInstanceId>
  13. </DBInstanceIds>
  14. <VSwitchId>vpc-25j4god4l</VSwitchId>
  15. <DefaultCooldown>20</DefaultCooldown>
  16. <LifecycleState>Active</LifecycleState>
  17. <LoadBalancerId>147b46d767c-cn-qingdao-cm5-a01</LoadBalancerId>
  18. <MaxSize>1</MaxSize>
  19. <MinSize>0</MinSize>
  20. <PendingCapacity>0</PendingCapacity>
  21. <RegionId>cn-qingdao</RegionId>
  22. <RemovingCapacity>0</RemovingCapacity>
  23. <ScalingGroupId>dyrSuvBOtO1dEdIlIbplQb8</ScalingGroupId>
  24. <ScalingGroupName>dyrSuvBOtO1dEdIlIbplQb8</ScalingGroupName>
  25. <RemovalPolicies>
  26. <RemovalPolicy>OldestScalingConfiguration</RemovalPolicy>
  27. <RemovalPolicy>OldestInstance</RemovalPolicy>
  28. </RemovalPolicies>
  29. <TotalCapacity>1</TotalCapacity>
  30. <CreationTime>2014-08-14T10:58Z</CreationTime>
  31. </ScalingGroup>
  32. </ScalingGroups>
  33. </DescribeScalingGroupsResponse>

JSON 形式

  1. {
  2. "RequestId": "68386699-8B9E-4D5B-BC4C-75A28F6C2A00",
  3. "TotalCount": 1,
  4. "PageSize": 10,
  5. "PageNumber": 1,
  6. "ScalingGroups": {
  7. "ScalingGroup": [
  8. {
  9. "ScalingGroupId": "b8pYCVbIV5k9cz4PWpbe0k19",
  10. "ScalingGroupName": "b8pYCVbIV5k9cz4PWpbe0k19",
  11. "RegionId": "cn-qingdao",
  12. "RemovingCapacity": 0,
  13. "DefaultCooldown": 300,
  14. "MinSize": 1,
  15. "MaxSize": 2,
  16. "LifecycleState": "Inactive",
  17. "ActiveScalingConfigurationId": " dyo713cNYIB4ddEVlKbcpOef",
  18. "LoadBalancerId": "147b46d767c-cn-qingdao-cm5-a01",
  19. "PendingCapacity": 0,
  20. "TotalCapacity": 0,
  21. "ActiveCapacity": 0,
  22. "CreationTime": "2014-08-14T10:58Z",
  23. "DBInstanceIds": {
  24. "DBInstanceId": [
  25. "rdsia3u3yia3u3y",
  26. "rdszzzyyunybaeu"
  27. ]
  28. },
  29. "VSwitchId":"vpc-25j4god4l",
  30. "RemovalPolicies": {
  31. "RemovalPolicy": [
  32. "OldestScalingConfiguration",
  33. "OldestInstance"
  34. ]
  35. }
  36. }
  37. ]
  38. }
  39. }