この API を呼び出して、複数のインスタンスのステータスを取得できます。
説明
- すべてのインスタンスステータスが返されます。 詳細は、インスタンスステータス をご参照ください。
- この API を呼び出して、インスタンスリストを取得することもできます。
デバッグ
API Explorer でデバッグを実行できます。 API Explorer で各種操作を実行して API の使用を簡素化できます。 たとえば、API の取得、API の呼び出し、SDK のサンプルコードの動的な生成ができます。
リクエストパラメーター
| 名前 | データ型 | 必須/省略可能 | 例 | 説明 |
|---|---|---|---|---|
| RegionId | String | 必須 | cn-hangzhou |
インスタンスのリージョン ID 。 DescribeRegions を実行すると、最新のリージョンリストが表示されます。 |
| Action | String | 省略可能 | DescribeInstanceStatus |
実行する操作。 値を DescribeInstanceStatus に設定します。 |
| ClusterId | String | 省略可能 | cls-clusterid1 |
インスタンスが属するクラスターの ID。 注 このパラメーターは削除予定です。 互換性を確保するために他のパラメーターを使用することを推奨します。
|
| OwnerAccount | String | 省略可能 | ECSforCloud |
RAM ユーザーのログインネーム。 |
| PageNumber | Integer | 省略可能 | 1 |
ページ番号。 この値は 1 から始まります。 既定値 : 1。 |
| PageSize | Integer | 省略可能 | 10 |
1 ページあたりの行数。 有効値：1 〜 50 。 既定値：1 |
| ZoneId | String | 省略可能 | cn-hangzhou |
インスタンスのゾーン ID 。 |
レスポンスパラメーター
| 名前 | データ型 | 例 | 説明 |
|---|---|---|---|
| InstanceStatuses |
返されたインスタンスステータスの情報。 これは、InstanceStatusSetType データで構成される配列です。 |
||
| └InstanceId | String | i-instance1 |
インスタンスの ID 。 |
| └Status | String | Running |
インスタンスの状態。 |
| PageNumber | Integer | 1 |
ページ番号。 |
| PageSize | Integer | 10 |
1 ページあたりの行数。 |
| RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
リクエスト ID 。 |
| TotalCount | Integer | 2 |
インスタンスの総数。 |
例
リクエスト例
https://ecs.aliyuncs.com/?Action=DescribeInstanceStatus
&RegionId=cn-hangzhou
&ZoneId=cn-hangzhou-d
&<Common request parameters>
通常のレスポンスの例
XML 形式
<DescribeInstanceStatusResponse>
<RequestId>6EF60BEC-0242-43AF-BB20-270359FB54A7</RequestId>
<TotalCount>2</TotalCount>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<InstanceStatuses>
<InstanceStatus>
<InstanceId>i-instance1</InstanceId>
<Status>Running</Status>
</InstanceStatus>
<InstanceStatus>
<InstanceId>i-ae4r89pp</InstanceId>
<Status>Stopped</Status>
</InstanceStatus>
</InstanceStatuses>
</DescribeInstanceStatusResponse>
JSON 形式
{
"PageNumber":1,
"InstanceStatuses":{
"InstanceStatus":[
{
"Status":"Running",
"InstanceId":"i-instance1"
},
{
"Status":"Stopped",
"InstanceId":"i-ae4r89pp"
}
]
},
"TotalCount":2,
"PageSize":10,
"RequestId":"6EF60BEC-0242-43AF-BB20-270359FB54A7"
}