呼叫 DescribeInstanceHistoryEvents 介面,並可以指定 InstanceId、EventType 等參數,查詢指定執行個體系統事件資訊,預設查詢處於非活躍狀態的歷史系統事件。
介面說明
-
您最多可以查詢最近 30 天的已完結歷史系統事件。對於未完結的系統事件無查詢時間限制。
-
未指定 EventCycleStatus 參數和 InstanceEventCycleStatus 參數時,查詢結果預設只包括處於 Avoided(事件已避免)、Executed(事件已完成執行)、Canceled(事件已取消)和 Failed(事件執行失敗)狀態的系統事件。
-
透過指定 InstanceEventCycleStatus 參數,還可以查詢處於 Scheduled(等待執行事件)、Executing(事件執行中)和 Inquiring(事件問詢中)狀態的系統事件。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
ecs:DescribeInstanceHistoryEvents |
get |
*All Resource
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
是 |
資源所在的地域 ID。您可以呼叫 DescribeRegions 查看最新的阿里雲地域列表。 |
cn-hangzhou |
| RegionId |
string |
是 |
資源所在的地域 ID。您可以呼叫 DescribeRegions 查看最新的阿里雲地域列表。 |
cn-hangzhou |
| InstanceId |
string |
否 |
執行個體 ID。不指定執行個體 ID 時,表示查詢您指定地域下所有執行個體的系統事件資訊。 |
i-uf678mass4zvr9n1**** |
| EventCycleStatus |
string |
否 |
系統事件的生命週期狀態。EventCycleStatus 只在未指定 InstanceEventCycleStatus.N 參數時有效。取值範圍:
|
Executed |
| EventType |
string |
否 |
系統事件的類型。EventType 參數只在未指定 InstanceEventType.N 參數時有效。取值範圍:
說明
事件類型說明請參見系統事件概述。該參數的取值只能是執行個體系統事件,不能是磁碟系統事件。 |
SystemMaintenance.Reboot |
| NotBefore.Start |
string |
否 |
查詢系統事件計劃執行時間的開始時間。按照 ISO 8601 標準表示,並需要使用 UTC +0 時間,格式為 yyyy-MM-ddTHH:mm:ssZ。 |
2017-11-30T06:32:31Z |
| NotBefore.End |
string |
否 |
查詢系統事件計劃執行時間的結束時間。按照 ISO 8601 標準表示,並需要使用 UTC +0 時間,格式為 yyyy-MM-ddTHH:mm:ssZ。 |
2017-12-01T06:32:31Z |
| EventPublishTime.Start |
string |
否 |
查詢系統事件發佈時間的開始時間。按照 ISO 8601 標準表示,並需要使用 UTC +0 時間,格式為 yyyy-MM-ddTHH:mm:ssZ。 |
2017-11-30T06:32:31Z |
| EventPublishTime.End |
string |
否 |
查詢系統事件發佈時間的結束時間。按照 ISO 8601 標準表示,並需要使用 UTC +0 時間,格式為 yyyy-MM-ddTHH:mm:ssZ。 |
2017-12-01T06:32:31Z |
| ImpactLevel |
string |
否 |
說明
該參數暫未開放使用。 |
null |
| PageNumber |
integer |
否 |
說明
該參數即將下線,建議您透過指定 MaxResults 或 NextToken 參數使用分頁方式查詢。 |
1 |
| PageSize |
integer |
否 |
說明
該參數即將下線,建議您透過指定 MaxResults 或 NextToken 參數使用分頁方式查詢。 |
10 |
| ResourceType |
string |
否 |
資源類型。取值範圍:
預設值:instance。 |
instance |
| EventId |
array |
否 |
一個或者多個系統事件 ID。N 的取值範圍為 1~100,多個取值使用重複列表的形式。 |
e-uf64yvznlao4jl2c**** |
|
string |
否 |
一個或者多個系統事件 ID。N 的取值範圍為 1~100,多個取值使用重複列表的形式。 |
e-uf64yvznlao4jl2c**** |
|
| InstanceEventCycleStatus |
array |
否 |
一個或者多個系統事件的生命週期狀態。N 的取值範圍:1~7,多個取值使用重複列表的形式。取值範圍:
|
Executed |
|
string |
否 |
一個或者多個系統事件的生命週期狀態。N 的取值範圍:1~7,多個取值使用重複列表的形式。取值範圍:
|
Executed |
|
| InstanceEventType |
array |
否 |
一個或者多個系統事件的類型。N 的取值範圍:1~30,多個取值使用重複列表的形式。取值範圍:
說明
事件類型說明請參見系統事件概述。該參數的取值只能是執行個體系統事件,不能是磁碟系統事件。 |
SystemMaintenance.Reboot |
|
string |
否 |
一個或者多個系統事件的類型。N 的取值範圍:1~30,多個取值使用重複列表的形式。取值範圍:
說明
事件類型說明請參見系統事件概述。該參數的取值只能是執行個體系統事件,不能是磁碟系統事件。 |
SystemMaintenance.Reboot |
|
| ResourceId |
array |
否 |
一個或多個資源 ID。N 的取值範圍為 1~100。參數的多個取值使用重複列表的形式。取值範圍:
如果不指定該參數,表示查詢指定地域( 說明
推薦您使用 |
i-uf678mass4zvr9n1**** |
|
string |
否 |
一個或多個資源 ID。N 的取值範圍為 1~100。參數的多個取值使用重複列表的形式。取值範圍:
如果不指定該參數,表示查詢指定地域( 說明
推薦您使用 |
i-uf678mass4zvr9n1**** |
|
| Tag |
array<object> |
否 |
系統事件支援的標籤列表。 |
|
|
object |
否 |
系統事件支援的標籤列表。 |
||
| Key |
string |
否 |
資源的標籤鍵。 |
TestKey |
| Value |
string |
否 |
資源的標籤值。 |
TestValue |
| ResourceGroupId |
string |
否 |
資源所在的資源群組 ID。 |
rg-bp67acfmxazb4p**** |
| NextToken |
string |
否 |
查詢憑證(Token),取值為上一次 API 呼叫返回的 NextToken 參數值。 |
f1c9fa9de5752*** |
| MaxResults |
integer |
否 |
分頁查詢時每頁的最大條目數。取值範圍:10~100。 預設值:
|
100 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
查詢的執行個體系統事件資訊。 |
||
| PageSize |
integer |
輸入時設定的每頁行數。 說明
|
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 標準表示,並需要使用 UTC +0 時間,格式為 yyyy-MM-ddTHH:mm:ssZ。 |
2017-11-30T06:32:31Z |
| EventFinishTime |
string |
系統事件結束時間。按照 ISO 8601 標準表示,並需要使用 UTC +0 時間,格式為 yyyy-MM-ddTHH:mm:ssZ。 |
2017-12-01T06:35:31Z |
| ResourceType |
string |
資源類型。可能值:
|
instance |
| ImpactLevel |
string |
影響級別。 |
100 |
| NotBefore |
string |
系統事件計劃執行時間。按照 ISO 8601 標準表示,並需要使用 UTC +0 時間,格式為 yyyy-MM-ddTHH:mm:ssZ。 |
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 標準表示,並需要使用 UTC +0 時間,格式為 yyyy-MM-ddTHH:mm:ssZ。 |
2018-11-30T06:32:31Z |
| DeviceSize |
string |
雲端硬碟或本地盤大小,單位 GiB。 |
80 |
| DeviceCategory |
string |
雲端硬碟或本地盤種類。可能值:
|
cloud_efficiency |
| DeviceType |
string |
雲端硬碟或本地盤類型。可能值:
|
data |
| ReleaseTime |
string |
雲端硬碟或本地盤釋放時間。按照 ISO 8601 標準表示,並需要使用 UTC +0 時間,格式為 yyyy-MM-ddTHH:mm:ssZ。 |
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 |
雲盒機櫃號。 |
A01 |
| PunishType |
string |
處罰類型。 |
ecs_message_alert |
| PunishDomain |
string |
安全違規網域名稱。 |
1228.test.com |
| PunishUrl |
string |
安全違規連結。 |
http://1228.test.com/1 |
| Code |
string |
安全違規 code。 |
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*** |
樣本
正常返回樣本
JSON格式
{
"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 status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 403 | InvalidParameter | %s | |
| 403 | EventIdLimitExceeded | %s | |
| 403 | InvalidParameter.TimeEndBeforeStart | %s | |
| 403 | OperationDenied.NotInWhiteList | %s | |
| 404 | MissingParameter | %s |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。