指定されたインスタンスのシステムイベントを照会します。デフォルトでは、この操作で非アクティブ状態の過去のシステムイベントを照会します。InstanceId、EventType などのパラメーターを指定できます。
操作説明
-
過去 30 日以内に発生した完了済みの過去のシステムイベントをクエリできます。未完了のシステムイベントのクエリに時間制限はありません。
-
EventCycleStatus パラメーターおよび InstanceEventCycleStatus パラメーターを指定しない場合、クエリ結果にはデフォルトで Avoided、Executed、Canceled、Failed 状態のシステムイベントのみが含まれます。
-
InstanceEventCycleStatus パラメーターを指定すると、Scheduled、Executing、Inquiring 状態のシステムイベントもクエリできます。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ecs:DescribeInstanceHistoryEvents |
get |
*All resources
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
リソースのリージョン ID。 DescribeRegions 操作を呼び出して、最新のリージョンリストをクエリできます。 |
cn-hangzhou |
| InstanceId |
string |
任意 |
インスタンスの ID。このパラメーターを指定しない場合、指定されたリージョン内のすべてのインスタンスのシステムイベントが照会されます。 |
i-uf678mass4zvr9n1**** |
| EventCycleStatus |
string |
任意 |
システムイベントのライフサイクルステータス。EventCycleStatus パラメーターは、InstanceEventCycleStatus.N パラメーターが指定されていない場合にのみ有効です。有効な値:
|
Executed |
| EventType |
string |
任意 |
システムイベントのタイプ。EventType パラメーターは、InstanceEventType.N パラメーターが指定されていない場合にのみ有効です。有効な値:
説明
イベントタイプの詳細については、「システムイベントの概要」を参照してください。このパラメーターの値は、ディスクシステムイベントではなく、インスタンスシステムイベントのみを指定できます。 |
SystemMaintenance.Reboot |
| NotBefore.Start |
string |
任意 |
システムイベントのスケジュールされた実行時間の開始時刻。ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 初期化で時刻を指定します。時刻は協定世界時 (UTC) である必要があります。 ISO 8601 |
2017-11-30T06:32:31Z |
| NotBefore.End |
string |
任意 |
システムイベントのスケジュールされた実行時間の終了時刻。ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 初期化で時刻を指定します。時刻は協定世界時 (UTC) である必要があります。 ISO 8601 |
2017-12-01T06:32:31Z |
| EventPublishTime.Start |
string |
任意 |
システムイベントの公開時間の開始時刻。ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 初期化で時刻を指定します。時刻は協定世界時 (UTC) である必要があります。 ISO 8601 |
2017-11-30T06:32:31Z |
| EventPublishTime.End |
string |
任意 |
システムイベントの公開時間の終了時刻。ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 初期化で時刻を指定します。時刻は協定世界時 (UTC) である必要があります。 ISO 8601 |
2017-12-01T06:32:31Z |
| ImpactLevel |
string |
任意 |
説明
このパラメーターは使用できません。 |
null |
| PageNumber |
integer |
任意 |
説明
このパラメーターはまもなく非推奨になります。ページングには MaxResults パラメーターまたは NextToken パラメーターを使用してください。 |
1 |
| PageSize |
integer |
任意 |
説明
このパラメーターはまもなく非推奨になります。ページングには MaxResults パラメーターまたは NextToken パラメーターを使用してください。 |
10 |
| ResourceType |
string |
任意 |
リソースタイプ。有効な値:
デフォルト値: instance。 |
instance |
| EventId |
array |
任意 |
1 つ以上のシステムイベントの ID。N の有効な値: 1~100。複数の値を繰り返しのリストで指定します。 |
e-uf64yvznlao4jl2c**** |
|
string |
任意 |
1 つ以上のシステムイベントの ID。N の有効な値: 1~100。複数の値を繰り返しのリストで指定します。 |
e-uf64yvznlao4jl2c**** |
|
| InstanceEventCycleStatus |
array |
任意 |
1 つ以上のシステムイベントのライフサイクルステータス。N の有効な値: 1~7。複数の値を繰り返しのリストで指定します。有効な値:
|
Executed |
|
string |
任意 |
1 つ以上のシステムイベントのライフサイクルステータス。N の有効な値: 1~7。複数の値を繰り返しのリストで指定します。有効な値:
|
Executed |
|
| InstanceEventType |
array |
任意 |
1 つ以上のシステムイベントのタイプ。N の有効な値: 1~30。複数の値を繰り返しのリストで指定します。有効な値:
説明
イベントタイプの詳細については、「システムイベントの概要」を参照してください。このパラメーターの値は、ディスクシステムイベントではなく、インスタンスシステムイベントのみを指定できます。 |
SystemMaintenance.Reboot |
|
string |
任意 |
1 つ以上のシステムイベントのタイプ。N の有効な値: 1~30。複数の値を繰り返しのリストで指定します。有効な値:
説明
イベントタイプの詳細については、「システムイベントの概要」を参照してください。このパラメーターの値は、ディスクシステムイベントではなく、インスタンスシステムイベントのみを指定できます。 |
SystemMaintenance.Reboot |
|
| ResourceId |
array |
任意 |
1 つ以上のリソースの ID。N の有効な値: 1~100。複数の値を繰り返しのリストで指定します。有効な値:
このパラメーターを指定しない場合、指定されたリージョン (RegionId) 内の指定されたリソースタイプ (ResourceType) のすべてのリソースのシステムイベントが照会されます。 説明
1 つ以上のリソース ID を指定するには、ResourceId.N パラメーターを使用します。ResourceId.N パラメーターと InstanceId パラメーターの両方を指定した場合、デフォルトでは ResourceId.N パラメーターが優先されます。 |
i-uf678mass4zvr9n1**** |
|
string |
任意 |
1 つ以上のリソースの ID。N の有効な値: 1~100。複数の値を繰り返しのリストで指定します。有効な値:
このパラメーターを指定しない場合、指定されたリージョン (RegionId) 内の指定されたリソースタイプ (ResourceType) のすべてのリソースのシステムイベントが照会されます。 説明
1 つ以上のリソース ID を指定するには、ResourceId.N パラメーターを使用します。ResourceId.N パラメーターと InstanceId パラメーターの両方を指定した場合、デフォルトでは ResourceId.N パラメーターが優先されます。 |
i-uf678mass4zvr9n1**** |
|
| Tag |
array<object> |
任意 |
システムイベントでサポートされているタグのリスト。 |
|
|
object |
任意 |
システムイベントでサポートされているタグのリスト。 |
||
| Key |
string |
任意 |
リソースのタグキー。 |
TestKey |
| Value |
string |
任意 |
リソースのタグ値。 |
TestValue |
| ResourceGroupId |
string |
任意 |
リソースが属するリソースグループの ID。 |
rg-bp67acfmxazb4p**** |
| NextToken |
string |
任意 |
クエリトークン。前の API 呼び出しから返された NextToken 値に設定します。 |
f1c9fa9de5752*** |
| MaxResults |
integer |
任意 |
ページング用の 1 ページあたりのエントリの最大値。有効な値: 10~100。 デフォルト値:
|
100 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
照会されたインスタンスのシステムイベント情報。 |
||
| PageSize |
integer |
リクエストで指定された 1 ページあたりのエントリ数。 説明
|
10 |
| RequestId |
string |
リクエスト ID |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| PageNumber |
integer |
インスタンスイベントリストのページ番号。 説明
|
1 |
| TotalCount |
integer |
インスタンスイベントの総数。 説明
ページングに MaxResults パラメーターと NextToken パラメーターを使用する場合、返される TotalCount 値に意味はありません。 |
2 |
| InstanceSystemEventSet |
object |
||
| InstanceSystemEventType |
array<object> |
インスタンスの過去のシステムイベントの配列。 |
|
|
array<object> |
インスタンスの過去のシステムイベント。 |
||
| EventId |
string |
システムイベントの ID。 |
e-uf64yvznlao4jl2c**** |
| EventPublishTime |
string |
システムイベントの公開時間。時間は ISO 8601 規格の yyyy-MM-ddTHH:mm:ssZ 形式で表示されます。時間は協定世界時 (UTC) です。 ISO 8601 |
2017-11-30T06:32:31Z |
| EventFinishTime |
string |
システムイベントの終了時間。時間は ISO 8601 規格の yyyy-MM-ddTHH:mm:ssZ 形式で表示されます。時間は協定世界時 (UTC) です。 ISO 8601 |
2017-12-01T06:35:31Z |
| ResourceType |
string |
リソースタイプ。有効な値:
|
instance |
| ImpactLevel |
string |
影響レベル。 |
100 |
| NotBefore |
string |
システムイベントの予定実行時間。時間は ISO 8601 規格の yyyy-MM-ddTHH:mm:ssZ 形式で表示されます。時間は協定世界時 (UTC) です。 ISO 8601 |
2017-12-06T00:00:00Z |
| InstanceId |
string |
インスタンス ID |
i-uf678mass4zvr9n1**** |
| Reason |
string |
システムイベントの原因。 |
System maintenance is scheduled due to ***. |
| EventType |
object |
システムイベントタイプ。 |
|
| Name |
string |
システムイベントタイプの名前。 |
InstanceExpiration.Stop |
| Code |
integer |
システムイベントタイプのコード。 |
34 |
| EventCycleStatus |
object |
システムイベントのライフサイクルステータス。 |
|
| Name |
string |
システムイベントステータスの名前。 |
Executed |
| Code |
integer |
システムイベントの状態コード。 |
0 |
| ExtendedAttribute |
object |
イベントの拡張属性。 |
|
| Device |
string |
ローカルディスクのデバイス名。 |
/dev/vda |
| DiskId |
string |
ローカルディスクの ID。 |
d-diskid1 |
| InactiveDisks |
object |
||
| InactiveDisk |
array<object> |
リリースされたがクリーンアップが必要な非アクティブなクラウドディスクまたはローカルディスクに関する情報のリスト。 |
|
|
object |
リリースされたがクリーンアップが必要な非アクティブなクラウドディスクまたはローカルディスクに関する情報。 |
||
| CreationTime |
string |
クラウドディスクまたはローカルディスクの作成時間。時間は ISO 8601 規格の yyyy-MM-ddTHH:mm:ssZ 形式で表示されます。時間は協定世界時 (UTC) です。 ISO 8601 |
2018-11-30T06:32:31Z |
| DeviceSize |
string |
クラウドディスクまたはローカルディスクのサイズ。単位: GiB。 |
80 |
| DeviceCategory |
string |
クラウドディスクまたはローカルディスクのカテゴリ。有効な値:
|
cloud_efficiency |
| DeviceType |
string |
クラウドディスクまたはローカルディスクのタイプ。有効な値:
|
data |
| ReleaseTime |
string |
クラウドディスクまたはローカルディスクのリリース時間。時間は ISO 8601 規格の yyyy-MM-ddTHH:mm:ssZ 形式で表示されます。時間は協定世界時 (UTC) です。 ISO 8601 |
2019-11-30T06:32:31Z |
| HostType |
string |
ホストタイプ。有効な値:
|
ddh |
| HostId |
string |
ホスト ID。 |
dh-bp1ewce1gk3iwv2**** |
| MigrationOptions |
object |
||
| MigrationOption |
array |
インスタンス移行オプション。現在、MigrationOptions (移行計画を使用した移行) のみがサポートされています。 |
|
|
string |
インスタンス移行オプション。現在、MigrationPlan (移行計画を使用した移行) のみがサポートされています。 |
MigrationPlan |
|
| OnlineRepairPolicy |
string |
損傷したクラウドディスクのオンライン修復ポリシー。有効な値: IsolateOnly。損傷したディスクの隔離のみがサポートされ、損傷したディスクの修復はサポートされないことを示します。 |
IsolateOnly |
| Rack |
string |
CloudBox のラック番号。 |
A01 |
| PunishType |
string |
処罰タイプ。 |
ecs_message_alert |
| PunishDomain |
string |
セキュリティ違反のあるドメイン名。 |
1228.test.com |
| PunishUrl |
string |
セキュリティ違反のある URL。 |
http://1228.test.com/1 |
| Code |
string |
セキュリティ違反のコード。 |
PR111 |
| CanAccept |
string |
イベントを処理できるかどうかを示します。 |
true |
| ResponseResult |
string |
イベントの応答結果。有効な値:
|
true |
| MetricValue |
string |
メトリック値。 |
18000 |
| MetricName |
string |
メトリック名。 |
in_mbps |
| InitialNotBefore |
string |
システムイベントの初期予定実行時間。 |
2026-06-22T00:00:00Z |
| ReasonCode |
string |
システムイベントの原因の分類コード。 |
VPCMigrationEcs |
| NextToken |
string |
この呼び出しで返されるクエリトークン。 説明
ページングに MaxResults パラメーターと NextToken パラメーターを使用する際に NextToken 値が返されない場合、返されるデータはそれ以上ありません。 |
f1c9fa9de5752*** |
例
成功レスポンス
JSONJSON
{
"PageSize": 10,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"PageNumber": 1,
"TotalCount": 2,
"InstanceSystemEventSet": {
"InstanceSystemEventType": [
{
"EventId": "e-uf64yvznlao4jl2c****",
"EventPublishTime": "2017-11-30T06:32:31Z",
"EventFinishTime": "2017-12-01T06:35:31Z",
"ResourceType": "instance",
"ImpactLevel": "100",
"NotBefore": "2017-12-06T00:00:00Z",
"InstanceId": "i-uf678mass4zvr9n1****",
"Reason": "System maintenance is scheduled due to ***.",
"EventType": {
"Name": "InstanceExpiration.Stop",
"Code": 34
},
"EventCycleStatus": {
"Name": "Executed",
"Code": 0
},
"ExtendedAttribute": {
"Device": "/dev/vda",
"DiskId": "d-diskid1",
"InactiveDisks": {
"InactiveDisk": [
{
"CreationTime": "2018-11-30T06:32:31Z",
"DeviceSize": "80",
"DeviceCategory": "cloud_efficiency",
"DeviceType": "data",
"ReleaseTime": "2019-11-30T06:32:31Z"
}
]
},
"HostType": "ddh",
"HostId": "dh-bp1ewce1gk3iwv2****",
"MigrationOptions": {
"MigrationOption": [
"MigrationPlan"
]
},
"OnlineRepairPolicy": "IsolateOnly",
"Rack": "A01",
"PunishType": "ecs_message_alert",
"PunishDomain": "1228.test.com",
"PunishUrl": "http://1228.test.com/1",
"Code": "PR111",
"CanAccept": "true",
"ResponseResult": "true",
"MetricValue": "18000",
"MetricName": "in_mbps",
"InitialNotBefore": "2026-06-22T00:00:00Z"
},
"ReasonCode": "VPCMigrationEcs"
}
]
},
"NextToken": "f1c9fa9de5752***"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 403 | InvalidParameter | %s | |
| 403 | EventIdLimitExceeded | %s | |
| 403 | InvalidParameter.TimeEndBeforeStart | %s | 指定されたパラメーターは無効です。終了時刻が開始時刻より早くなっていないか確認してください。 |
| 403 | OperationDenied.NotInWhiteList | %s | この操作は無効です。まずアカウントをホワイトリストに追加してください。 |
| 404 | MissingParameter | %s |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。