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

Query the list of ECS instances in

最終更新日: Mar 18, 2020

説明

スケーリンググループの ECS インスタンスのリストを照会します。スケーリンググループ ID、スケーリング設定 ID、ヘルスステータス、ライフサイクルステータス、および作成タイプで照会できます。

(1) スケーリンググループの ECS インスタンスは、自動的に作成することも、手動でアタッチすることもできます。

  • ECS インスタンスは、スケーリング設定およびルールに基づいて、Auto Scaling サービスによって自動的に作成できます。
  • ECS インスタンスは、スケーリンググループに手動でアタッチすることもできます。

(2) スケーリンググループの ECS インスタンスは、そのライフサイクルの間に次の状態になります。

  • Pending: インスタンスの作成、Server Load Balancer へのアタッチ、RDS のアクセスホワイトリストへの追加などの操作により、ECS インスタンスはスケーリンググループへのアタッチ中です。
  • InService: ECS インスタンスはスケーリンググループに正常に追加され、サービスを適切に提供しています。
    • Removing: ECS インスタンスはスケーリンググループから削除中です。

(3) スケーリンググループの ECS インスタンスは、次のヘルス状態になります。

  • Healthy: ECS インスタンスは正常です。
  • Unhealthy: ECS インスタンスは異常です (実行中でない場合)。

(4) Auto Scaling サービスでは、異常な ECS インスタンスをスケーリンググループから自動的に削除します。異常な ECS インスタンスが自動的に作成されたものである場合、そのインスタンスを無効にしてリリースします。異常な ECS インスタンスが手動でアタッチされたものである場合、そのインスタンスを無効にすることも、リリースすることもありません。

リクエストパラメーター

名前 必須かどうか 説明
Action String はい 操作インターフェイス名、必須パラメーター。値: DescribeScalingInstances。
RegionId String はい スケーリンググループが存在するリージョンの ID。
ScalingGroupId String いいえ スケーリンググループ ID。
ScalingConfigurationId String いいえ 関連するスケーリング設定の ID。
InstanceId.N String いいえ ECS インスタンス ID。最大 20 個の ID を入力できます。無効なインスタンス ID は、クエリ結果に表示されず、エラーは報告されません。
HealthStatus String いいえ スケーリンググループの ECS インスタンスのヘルスステータス。オプション: Healthy および Unhealthy。
LifecycleState String いいえ スケーリンググループの ECS インスタンスのライフサイクルステータス。オプション: InService (ECS インスタンスは、スケーリンググループに追加されており、正常に稼動しています)、Pending (ECS インスタンスは、関連する設定が未完了のスケーリンググループにアタッチ中です)、および Removing (ECS インスタンスは、スケーリンググループから削除中です)。
CreationType String いいえ ECS インスタンスの作成タイプ。オプション: AutoCreated (ECS インスタンスは、Auto Scaling サービスにより、自動的にスケーリンググループに作成されます) および Attached (ECS インスタンスは、Auto Scaling サービスの外部で作成され、手動でスケーリンググループにアタッチされます)。
PageNumber Integer いいえ ECS インスタンスリストのページ番号 (1 から始まります)。デフォルト値: 1。
PageSize Integer いいえ ページで照会する場合、このパラメーターは、ページあたりの行数を示します。最大値: 50。デフォルト値: 10。

リターンパラメーター

名前 説明
TotalCount Integer ECS インスタンスの総数
PageNumber Integer 現在のページ番号
PageSize Integer ページあたりの行数
ScalingInstances ScalingInstanceSetType ECS インスタンス情報のセット

ScalingInstanceSetType は、ScalingInstanceItemType のセットです。

名前 説明
ScalingInstance ScalingInstanceItemType ECS インスタンス情報

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

名前 説明
InstanceId String ECS インスタンス ID。
ScalingGroupId String ECS インスタンスが属するスケーリンググループの ID。
ScalingConfigurationId String 関連するスケーリング設定の ID。
HealthStatus String スケーリンググループの ECS インスタンスのヘルスステータス。
LifecycleState String スケーリンググループの ECS インスタンスのライフサイクルステータス。
CreationTime String ECS インスタンスがスケーリンググループにアタッチされた時刻。
CreationType String ECS インスタンスの作成タイプ。

エラーコード

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

リクエストの例

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

戻り値の例

XML の例

  1. <DescribeScalingInstancesResponse>
  2. <RequestId>DFF8797F-5B73-4BD7-A7D0-03479C458F7A</RequestId>
  3. <TotalCount>1</TotalCount>
  4. <PageNumber>1</PageNumber>
  5. <PageSize>10</PageSize>
  6. <ScalingInstances>
  7. <ScalingInstance>
  8. <CreationTime>2014-08-15T17:37Z</CreationTime>
  9. <CreationType>AutoCreated</CreationType>
  10. <HealthStatus>Healthy</HealthStatus>
  11. <InstanceId>i-283vvyytn</InstanceId>
  12. <LifecycleState>InService</LifecycleState> <ScalingConfigurationId>
  13. cGsGHrdMBa3DcDrrBVcc4k2H
  14. </ScalingConfigurationId>
  15. <ScalingGroupId>dBCYxE26IHKcGq1xPcTNBwV</ScalingGroupId>
  16. </ScalingInstance>
  17. </ScalingInstances>
  18. </DescribeScalingInstancesResponse>

JSON 形式

  1. {
  2. "RequestId": "13305F2D-A4C2-4E6B-B7C7-0F2150842EA3",
  3. "TotalCount": 1,
  4. "PageNumber": 1,
  5. "PageSize": 50,
  6. "ScalingInstances": {
  7. "ScalingInstance": [
  8. {
  9. "ScalingConfigurationId": "bU5uZHcAgtzwcL4IeDeavqTS",
  10. "CreationType": "AutoCreated",
  11. "InstanceId": "i-28sov3exk",
  12. "CreationTime": "2014-08-14T10:59Z",
  13. "HealthStatus": "Healthy",
  14. "LifecycleState": "InService",
  15. "ScalingGroupId": "dE9YbOdCHqaFdFZHXVdDjQCB"
  16. }
  17. ]
  18. }
  19. }