1 つ以上のインスタンスの完全なステータス情報を照会します。 完全なステータス情報には、インスタンスステータスとインスタンスイベントステータスが含まれます。 インスタンスステータスは、インスタンスのライフサイクルステータスです。 インスタンスイベントステータスは、メンテナンスイベントのヘルスステータスです。 詳細については、「ECS インスタンスのライフサイクルとシステムイベント」をご参照ください。
説明
レスポンスには、インスタンスとスケジュールされたシステムイベントに関するステータス情報が含まれます。
期間を指定すると、その期間内のすべてのイベントが照会されます。
デバッグ
API Explorer を使用してデバッグを実行できます。 API Explorer を使用することで、さまざまな操作を実行して API の使用を簡素化できます。 たとえば、API の取得、API の呼び出し、SDK サンプルコードの動的生成を行うことができます。
リクエストパラメーター
パラメーター名 | データ型 | 必須/任意 | 例 | 説明 |
---|---|---|---|---|
RegionId | String | 必須 | cn-hangzhou |
インスタンスが配置されているリージョンの ID。 DescribeRegions を呼び出して、Alibaba Cloud の最新のリージョンを表示できます。 |
Action | String | 任意 | DescribeInstancesFullStatus |
実行する操作。 値をDescribeInstancesFullStatus に設定します。 |
EventId.N | RepeatList | 任意 | [EventId. 1="e-xhskHun1256xxxx",EventId. 2="e-xhskHun1257xxxx"……] |
1 つ以上のイベントの ID。 N の有効な値 : 1~100 。 繰り返しリストの形式で複数の値を指定できます。 |
EventPublishTime.End | String | 任意 | 2017-12-07T00:00:00Z |
システムイベントがプッシュされる期間の終了時刻。 時刻は ISO 8601 標準に従い、UTC 時間を使用します。 形式は yyyy-MM-ddTHH:mm:ssZ です。 |
EventPublishTime.Start | String | 任意 | 2017-11-30T00:00:00Z |
システムイベントがプッシュされる期間の開始時刻。 時刻はISO 8601 標準に従い、UTC 時間を使用します。 形式は yyyy-MM-ddTHH:mm:ssZ です。 |
EventType | String | 任意 | InstanceExpiration.Stop |
イベントのタイプ。 EventType パラメーターは、InstanceEventType.N パラメーターが指定されていない場合にのみ有効です。 有効な値:
|
HealthStatus | String | 任意 | Maintaining |
インスタンスのヘルスステータス。 有効な値:
すべての値は大文字と小文字が区別されます。 |
InstanceEventType.N | RepeatList | 任意 | InstanceExpiration.Stop |
1 つ以上のイベントのタイプ。 N の有効な値 : 1~30 。 繰り返しリストの形式で複数の値を指定できます。 有効な値。
|
InstanceId.N | RepeatList | 任意 | [InstanceId. 1="i-instance1",InstanceId. 2="i-instance2"……] |
1 つ以上のインスタンスの ID。 N の有効な値 : 1~100 。 繰り返しリストの形式で複数の値を指定できます。 |
NotBefore.End | String | 任意 | 2017-11-30T00:00:00Z |
スケジュールされたイベント実行期間の終了時刻。 時刻は ISO 8601 標準に従い、UTC 時間を使用します。 形式は yyyy-MM-ddTHH:mm:ssZ です。 |
NotBefore.Start | String | 任意 | 2017-12-07T00:00:00Z |
スケジュールされたイベント実行期間の開始時刻。 時刻は ISO 8601 標準に従い、UTC 時間を使用します。 形式は yyyy-MM-ddTHH:mm:ssZ です。 |
PageNumber | Integer | 任意 | 1 |
クエリ結果のページ番号。 値は整数である必要があります。 デフォルト値 : 1 。 |
PageSize | Integer | 任意 | 10 |
ページごとのエントリ数。 有効な値: 1~100。 デフォルト値 : 10 。 |
Status | String | 任意 | Running |
指定されたインスタンスのライフサイクルステータス。 有効な値:
|
レスポンスパラメーター
パラメーター名 | データ型 | 例 | 説明 |
---|---|---|---|
InstanceFullStatusSet |
InstanceFullStatus データの配列。 |
||
└HealthStatus |
インスタンスのヘルスステータス。 |
||
└Code | Integer | 64 |
ヘルスステータスのコード。 |
└Name | String | Warning |
ヘルスステータスの名前。 |
└InstanceId | String | i-instance1 |
インスタンスの ID。 |
└ScheduledSystemEventSet |
ScheduledSystemEvent データの配列。 |
||
└EventCycleStatus |
イベントのステータス。 |
||
└Code | Integer | 24 |
イベントステータスのコード。 |
└Name | String | Scheduled |
イベントステータスの名前。 |
└EventId | String | e-event1 |
インスタンスイベントの ID 。 |
└EventPublishTime | String | 2017-11-30T06:32:31Z |
イベントの公開時間。 時刻はISO 8601標準に従い、UTC 時間を使用します。 形式は yyyy-MM-ddTHH:mm:ssZ です。 |
└EventType |
イベントのタイプ。 |
||
└Code | Integer | 1 |
イベントタイプのコード。 |
└Name | String | SystemMaintenance.Reboot |
イベントタイプの名前。 |
└ExtendedAttribute |
ローカルディスクを持つインスタンスのシステムイベントの拡張属性。 |
||
└Device | String | /dev/vdb |
ローカルディスクのデバイス名。 |
└DiskId | String | d-diskid2 |
ローカルディスクの ID。 |
└NotBefore | String | 2017-12-07T00:00:00Z |
イベントのスケジュールされた実行時間。 時刻は ISO 8601 標準に従い、UTC 時間を使用します。 形式は、yyyy-MM-ddTHH:mm:ssZ です。 |
└Status |
インスタンスのライフサイクルのステータス。 |
||
└Code | Integer | 1 |
インスタンスのライフサイクルステータスのコード。 |
└Name | String | Running |
インスタンスのライフサイクルステータスの名前。 |
PageNumber | Integer | 1 |
ページ番号。 |
PageSize | Integer | 10 |
ページごとのエントリ数。 |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
リクエストの ID。 |
TotalCount | Integer | 2 |
エントリの合計数 |
例
リクエストの例
https://ecs.aliyuncs.com/?Action=DescribeInstancesFullStatus
&RegionId=cn-hangzhou
&InstanceId.1=i-instance1
&EventId.1=e-event1
&Status=Running
&HealthStatus=Maintaining
&InstanceEventType.1=InstanceExpiration.Stop
&EventType=InstanceExpiration.Stop
&NotBefore.Start=2017-12-07T00:00:00Z
&NotBefore.End=2017-11-30T00:00:00Z
&EventPublishTime.Start=2017-11-30T00:00:00Z
&EventPublishTime.End=2017-12-07T00:00:00Z
&PageNumber=1
&PageSize=10
&<Common request parameters>
成功したレスポンスの例
XML
形式
<DescribeInstancesFullStatusResponse>
<InstanceFullStatusSet>
<InstanceFullStatusType>
<InstanceId>i-instance1</InstanceId>
<Status>
<Code>1</Code>
<Name>Running</Name>
</Status>
<HealthStatus>
<Code>0</Code>
<Name>Maintaining</Name>
</HealthStatus>
<ScheduledSystemEventSet>
<ScheduledSystemEventType>
<EventId>e-event1</EventId>
<EventCycleStatus>
<Code>24</Code>
<Name>Scheduled</Name>
</EventCycleStatus>
<EventType>
<Code>1</Code>
<Name>SystemMaintenance.Reboot</Name>
</EventType>
<EventPublishTime>2017-11-30T06:32:31Z</EventPublishTime>
<NotBefore>2017-12-01T06:32:31Z</NotBefore>
</ScheduledSystemEventType>
<ScheduledSystemEventType>
<EventId>e-event2</EventId>
<EventCycleStatus>
<Code>24</Code>
<Name>Scheduled</Name>
</EventCycleStatus>
<EventType>
<Code>34</Code>
<Name>InstanceExpiration.Stop</Name>
</EventType>
<EventPublishTime>2017-11-30T00:00:00Z</EventPublishTime>
<NotBefore>2017-12-07T00:00:00Z</NotBefore>
</ScheduledSystemEventType>
</ScheduledSystemEventSet>
</InstanceFullStatusType>
<InstanceFullStatusType>
<InstanceId>i-instance2</InstanceId>
<Status>
<Code>1</Code>
<Name>Running</Name>
</Status>
<HealthStatus>
<Code>64</Code>
<Name>Warning</Name>
</HealthStatus>
<ScheduledSystemEventSet>
<ScheduledSystemEventType>
<EventId>e-event3</EventId>
<EventCycleStatus>
<Code>24</Code>
<Name>Scheduled</Name>
</EventCycleStatus>
<EventType>
<Code>65</Code>
<Name>SystemFailure.Reboot</Name>
</EventType>
<EventPublishTime>2017-11-30T06:32:31Z</EventPublishTime>
<NotBefore>2017-12-01T06:32:31Z</NotBefore>
</ScheduledSystemEventType>
</ScheduledSystemEventSet>
</InstanceFullStatusType>
</InstanceFullStatusSet>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
<TotalCount>2</TotalCount>
<RequestId>AAC49D3E-ED6F-4F00-XXXX-377C551B1DD4</RequestId>
</DescribeInstancesFullStatusResponse>
JSON
形式
{
"PageNumber":1,
"TotalCount":2,
"PageSize":10,
"InstanceFullStatusSet":{
"InstanceFullStatusType":[
{
"Status":{
"Name":"Running",
"Code":1
},
"HealthStatus":{
"Name":"Maintaining",
"Code":0
},
"InstanceId":"i-instance1",
"ScheduledSystemEventSet":{
"ScheduledSystemEventType":[
{
"EventPublishTime":"2017-11-30T06:32:31Z",
"NotBefore":"2017-12-01T06:32:31Z",
"EventId":"e-event1",
"EventType":{
"Name":"SystemMaintenance.Reboot",
"Code":1
},
"EventCycleStatus":{
"Name":"Scheduled",
"Code":24
}
},
{
"EventPublishTime":"2017-11-30T00:00:00Z",
"NotBefore":"2017-12-07T00:00:00Z",
"EventId":"e-event2",
"EventType":{
"Name":"InstanceExpiration.Stop",
"Code":34
},
"EventCycleStatus":{
"Name":"Scheduled",
"Code":24
}
}
]
}
},
{
"Status":{
"Name":"Running",
"Code":1
},
"HealthStatus":{
"Name":"Warning",
"Code":64
},
"InstanceId":"i-instance2",
"ScheduledSystemEventSet":{
"ScheduledSystemEventType":[
{
"EventPublishTime":"2017-11-30T06:32:31Z",
"NotBefore":"2017-12-01T06:32:31Z",
"EventId":"e-event3",
"EventType":{
"Name":"SystemFailure.Reboot",
"Code":65
},
"EventCycleStatus":{
"Name":"Scheduled",
"Code":24
}
}
]
}
}
]
},
"RequestId":"AAC49D3E-ED6F-4F00-XXXX-377C551B1DD4"
}
エラーコード
HTTP ステータスコード | エラーコード | エラーメッセージ | 説明 |
---|---|---|---|
404 | MissingParameter | %s | 必須パラメーターが指定されていない場合に返されるエラーメッセージ。 |
403 | InvalidParameter | %s | パラメーターの形式が無効な場合に返されるエラーメッセージ。 |
403 | InvalidParameter.TimeEndBeforeStart | %s | 終了時刻が開始時刻より前の場合に返されるエラーメッセージ。 |
403 | OperationDenied.NotInWhiteList | %s | この操作を実行する権限がない場合に返されるエラーメッセージ。 |
403 | InstanceIdLimitExceeded | %s | 指定されたインスタンス ID が 100 を超える場合に返されるエラーメッセージ。 |
403 | EventIdLimitExceeded | %s | 100 を超えるシミュレートされたイベント ID が指定された場合に返されるエラーメッセージ。 |