DescribeInstanceStatus - Elastic Compute Service - Alibaba Cloud ドキュメントセンター

操作説明

ECS インスタンスのライフサイクル状態の詳細については、「インスタンスのライフサイクル」をご参照ください。

リクエストの例

特定のリージョン内の ECS インスタンスとそのステータスを照会します。リクエストの例：

"RegionID": "cn-hangzhou"

特定のリージョンのゾーン内の ECS インスタンスとそのステータスを照会します。リクエストの例：

"RegionID": "cn-hangzhou",
"ZoneID": "cn-hangzhou-a"

インスタンス ID に基づいて、特定のリージョン内の ECS インスタンスのステータスを照会します。リクエストの例：

"RegionID": "cn-hangzhou",
"InstancesID": ["i-bp1f7c1zqp999zvp****", "i-bp1dqjv36biueg61****"]

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecs:DescribeInstanceStatus

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	インスタンスのリージョン ID。 DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。	cn-hangzhou
ZoneId	string	任意	インスタンスのゾーン ID。 DescribeZones 操作を呼び出して、最新のゾーンリストを照会できます。	cn-hangzhou-d
ClusterId	string	任意	ECS インスタンスが属するクラスターの ID です。説明このパラメーターは非推奨です。使用しないことを推奨します。	cls-bp67acfmxazb4p****
PageNumber	integer	任意	ページ番号。ページは 1 から始まります。デフォルト値：1。	1
PageSize	integer	任意	1 ページあたりのエントリ数。有効値：1～50。デフォルト値：10。	10
InstanceId	array	任意	ECS インスタンスの ID。 1～100 個のインスタンス ID を配列で指定できます。例：["i-bp1j4i2jdf3owlhe**", "i-bp1j4i2jdf3o1234**"]。	i-bp1j4i2jdf3owlhe****
	string	任意	ECS インスタンスの ID。	i-bp1j4i2jdf3owlhe****

レスポンスフィールド

フィールド	型	説明	例
	object
PageSize	integer	1 ページあたりのエントリ数。	1
RequestId	string	リクエスト ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	ページ番号。	1
TotalCount	integer	インスタンスの総数。	58
InstanceStatuses	object
InstanceStatus	array<object>	ECS インスタンスの ID とステータス。
	object
Status	string	インスタンスのステータス。有効値： Pending：インスタンスは作成中です。 Running：インスタンスは実行中です。 Starting：インスタンスは起動中です。 Stopping：インスタンスは停止中です。 Stopped：インスタンスは停止済みです。	Running
InstanceId	string	インスタンスの ID。	i-bp1j4i2jdf3owlhe****

例

成功レスポンス

JSONJSON

{
  "PageSize": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 58,
  "InstanceStatuses": {
    "InstanceStatus": [
      {
        "Status": "Running",
        "InstanceId": "i-bp1j4i2jdf3owlhe****"
      }
    ]
  }
}

エラーレスポンス

JSONJSON

{
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"TotalCount": 2,
"PageNumber": 1,
"PageSize": 10,
"InstanceStatuses": {
    "InstanceStatus": [{
        "InstanceId": "i-instance1",
            "Status": "Running"
        },
        {
            "InstanceId": "i-ae4r89pp",
            "Status": "Stopped"
        }]
    }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
403	InvalidParameter.TooManyInstanceIds	Instance ids cannot be more than 100.
403	Abs.InvalidInstanceIds.MalFormed	The specified instanceIds is not valid.
404	InvalidZoneId.NotFound	The ZoneId provided does not exist in our records.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。