この操作を呼び出して、指定したインスタンスのシステムイベントを照会できます。 無効な履歴システムイベントは、デフォルトで照会されます。 過去 7 日間のシステムイベントを照会できます。 InstanceEventCycleStatus パラメーターを指定して、[スケジュール済み] または [実行中] ステータスのシステムイベントを照会できます。
デバッグ
API の使用を簡単にするため、Alibaba Cloud では、OpenAPI Explorer を提供しています。 OpenAPI Explorer を使用して、API の検索、API の呼び出し、および SDK サンプルコードの動的な生成を行うことができます。
リクエストパラメーター
パラメーター | データ型 | 必須/任意 | 例 | 説明 |
---|---|---|---|---|
RegionId | String | 必須 | cn-hangzhou |
システムイベントを照会するインスタンスのリージョン ID。 最新のリージョン一覧は、DescribeRegions 操作を呼び出して照会できます。 |
Action | String | 任意 | DescribeInstanceHistoryEvents |
実行する操作。 HTTP および HTTPS メソッドを使用した API リクエストの場合、 |
EventCycleStatus | String | 任意 | Executed |
システムイベントのライフサイクルステータス。 このパラメーターは、InstanceEventCycleStatus.N パラメーターが指定されていない場合にのみ有効です。 有効な値:
|
EventId.N | RepeatList | 任意 | e-2ze9yxxxxwtqcvai68rl |
1 つ以上のシステムイベントの ID。 N の有効値 : 1~100 。 イベント ID は、繰り返しリスト形式で表示する必要があります。 |
EventPublishTime.End | String | 任意 | 2017-12-01T06:32:31Z |
この時間範囲内に発行されたシステムイベントが照会される範囲の終了時刻。 yyyy-MM-ddTHH:mm:ssZ 形式で ISO 8601 標準に従って時刻を指定します。 時刻は UTC にする必要があります。 |
EventPublishTime.Start | String | 任意 | 2017-11-30T06:32:31Z |
この時間範囲内に発行されたシステムイベントが照会される範囲の開始時刻。 yyyy-MM-ddTHH:mm:ssZ 形式で ISO 8601 標準に従って時刻を指定します。 時刻は UTC にする必要があります。 |
EventType | String | 任意 | SystemMaintenance.Reboot |
システムイベントのタイプ。 このパラメーターは、InstanceEventType.N パラメーターが指定されていない場合にのみ有効です。 有効な値:
|
InstanceEventCycleStatus.N | RepeatList | 任意 | Executed |
1 つ以上のシステムイベントのライフサイクルステータス。 N の有効値 : 1~6 。 複数の値は、繰り返しリストの形式で表示する必要があります。 有効な値:
|
InstanceEventType.N | RepeatList | 任意 | SystemMaintenance.Reboot |
1 つ以上のシステムイベントのタイプ。 N の有効値 : 1~30 。 複数の値は、繰り返しリストの形式で表示する必要があります。 有効な値:
|
InstanceId | String | 任意 | i-myInstance |
照会するインスタンスの ID。 インスタンス ID が指定されていない場合、指定されたリージョンのすべてのインスタンスのシステムイベントが照会されます。 |
NotBefore.End | String | 任意 | 2017-12-01T06:32:31Z |
この時間範囲内に実行がスケジュールされているシステムイベントが照会される範囲の終了時刻。 yyyy-MM-ddTHH:mm:ssZ 形式で ISO 8601 標準に従って時刻を指定します。 時刻は UTC にする必要があります。 |
NotBefore.Start | String | 任意 | 2017-11-30T06:32:31Z |
この時間範囲内に実行がスケジュールされているシステムイベントが照会される範囲の開始時刻。 yyyy-MM-ddTHH:mm:ssZ 形式で ISO 8601 標準に従って時刻を指定します。 時刻は UTC にする必要があります。 |
PageNumber | Integer | 任意 | 1 |
返すページの番号。 ページは 1 ページから始まります。 デフォルト値:1 |
PageSize | Integer | 任意 | 10 |
各ページに返されるエントリの数。 有効な値: 1~100。 デフォルト値:10 |
レスポンスパラメーター
パラメーター | データ型 | 例 | 説明 |
---|---|---|---|
InstanceSystemEventSet |
インスタンスのシステムイベントの配列。 |
||
└EventCycleStatus |
システムイベントのライフサイクルステータス。 |
||
└Code | Integer | 0 |
システムイベントのステータスコード。 |
└Name | String | Executed |
システムイベントのステータス名。 |
└EventFinishTime | String | 2017-12-01T06:35:31Z |
システムイベントが終了した時刻。 時刻は yyyy-MM-ddThh:mmZ 形式で ISO 8601 標準に従います。 時刻は UTC で表示されます。 |
└EventId | String | e-2ze9yxxxxwtqcvai68rx |
システムイベントの ID。 |
└EventPublishTime | String | 2017-11-30T06:32:31Z |
システムイベントが公開された時刻。 時刻は yyyy-MM-ddThh:mmZ 形式で ISO 8601 標準に従います。 時刻は UTC で表示されます。 |
└EventType |
システムイベントのタイプ。 |
||
└Code | Integer | 34 |
システムイベントタイプのコード。 |
└Name | String | InstanceExpiration.Stop |
システムイベントタイプの名前。 |
└ExtendedAttribute |
システムイベントの拡張属性。 |
||
└Device | String | /dev/vda |
ローカルディスクのデバイス名。 |
└DiskId | String | d-diskid1 |
ローカルディスクの ID。 |
└InstanceId | String | i-myInstance |
インスタンスの ID。 |
└NotBefore | String | 2017-12-06T00:00:00Z |
システムイベントのスケジュールされた実行時間。 時刻は yyyy-MM-ddThh:mmZ 形式で ISO 8601 標準に従います。 時刻は GMT で表示されます。 |
PageNumber | Integer | 1 |
返されたページの番号。 |
PageSize | Integer | 10 |
各ページに返されるエントリの数です。 |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
リクエストの ID。 |
TotalCount | Integer | 2 |
インスタンス状態の総数。 |
例
リクエストの例
https://ecs.aliyuncs.com/?Action=DescribeInstanceHistoryEvents
&RegionId=cn-hangzhou
&InstanceId = i-myInstance
&EventId. 1=e-2ze9yxxxxwtqcvai68rl
&InstanceEventCycleStatus. 1=Executed
&EventCycleStatus=Executed
&InstanceEventType. 1=SystemMaintenance.Reboot
&EventType=SystemMaintenance.Reboot
&NotBefore.Start=2017-11-30T06:32:31Z
&NotBefore.End=2017-12-01T06:32:31Z
&EventPublishTime.Start=2017-11-30T06:32:31Z
&EventPublishTime.End=2017-12-01T06:32:31Z
&PageNumber=1
&PageSize=10
&<Common request parameters>
レスポンスの成功例
XML
形式
<DescribeInstanceHistoryEventsResponse>
<InstanceSystemEventSet>
<InstanceSystemEventType>
<InstanceId>i-2ze3tphuqvc93cixxxx3</InstanceId>
<EventId>e-2ze9yxxxxwtqcvai68rl</EventId>
<EventRule>
<Code>1</Code>
<Name>SystemMaintenance.Reboot</Name>
</EventType>
<EventCycleStatus>
<Code>0</Code>
<Name>Executed</Name>
</EventCycleStatus>
<EventPublishTime>2017-11-30T06:32:31Z</EventPublishTime>
<NotBefore>2017-12-01T06:32:31Z</NotBefore>
<EventFinishTime>2017-12-01T06:35:31Z</EventFinishTime>
</InstanceSystemEventType>
<InstanceSystemEventType>
<InstanceId>i-2ze3tphuqvc93cixxxx3</InstanceId>
<EventId>e-2ze9yxxxxwtqcvai68r3</EventId>
<EventType>
<Code>34</Code>
<Name>InstanceExpiration.Stop</Name>
</EventType>
<EventCycleStatus>
<Code>8</Code>
<Name>Avoided</Name>
</EventCycleStatus>
<EventPublishTime>2017-11-29T06:32:31Z</EventPublishTime>
<NotBefore>2017-12-06T00:00:00Z</NotBefore>
<EventFinishTime>2017-12-05T12:35:31Z</EventFinishTime>
</InstanceSystemEventType>
</InstanceSystemEventSet>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
<TotalCount>2</TotalCount>
<RequestId>02EA76D3-5A2A-44EB-XXXX-8901881D8707</RequestId>
</DescribeInstanceHistoryEventsResponse>
JSON
形式
{
"PageNumber":1,
"TotalCount":2,
"PageSize":10,
"RequestId":"02EA76D3-5A2A-44EB-XXXX-8901881D8707",
"InstanceSystemEventSet":{
"InstanceSystemEventType":[
{
"EventPublishTime":"2017-11-30T06:32:31Z",
"NotBefore":"2017-12-01T06:32:31Z",
"EventFinishTime":"2017-12-01T06:35:31Z",
"InstanceId":"i-2ze3tphuqvc93cixxxx3",
"EventId":"e-2ze9yxxxxwtqcvai68rl",
"EventType":{
"Name":"SystemMaintenance.Reboot",
"Code":1
},
"EventCycleStatus":{
"Name":"Executed",
"Code":0
}
},
{
"EventPublishTime":"2017-11-29T06:32:31Z",
"NotBefore":"2017-12-06T00:00:00Z",
"EventFinishTime":"2017-12-05T12:35:31Z",
"InstanceId":"i-2ze3tphuqvc93cixxxx3",
"EventId":"e-2ze9yxxxxwtqcvai68r3",
"EventType":{
"Name":"InstanceExpiration.Stop",
"Code":34
},
"EventCycleStatus":{
"Name":"Avoided",
"Code":8
}
}
]
}
}
エラーコード
HTTP ステータスコード | エラーコード | エラーメッセージ | 説明 |
---|---|---|---|
404 | MissingParameter | %s | 必須パラメーターが指定されていない場合に返されるエラーメッセージ。 |
403 | InvalidParameter | %s | パラメーターの形式が無効であるために返されるエラーメッセージ。 |
403 | EventIdLimitExceeded | %s | 100 を超えるシステムイベント ID が指定されている場合に返されるエラーメッセージ。 |
403 | InvalidParameter.TimeEndBeforeStart | %s | 終了時刻が、開始時刻より前の場合に返されるエラーメッセージ。 |
403 | OperationDenied.NotInWhiteList | %s | この操作を実行する権限がない場合に返されるエラーメッセージ。 |