查詢指定執行個體的事件資訊,預設查詢處於非活躍狀態的曆史事件。目前,您最多可以查詢最近一周的曆史事件。
請求參數
名稱 | 類型 | 是否必需 | 描述 |
---|---|---|---|
Action | String | 是 | 系統規定參數。取值:DescribeInstanceHistoryEvents |
RegionId | String | 是 | 執行個體所在地域 ID。您可以調用 DescribeRegions 查看最新的阿里雲地域列表。 |
InstanceId | String | 否 | 執行個體 ID。不指定執行個體 ID 時,表示查詢您指定地域下所有執行個體的事件資訊。 |
EventId.N | String | 否 | 一個或者多個事件 ID。N 的取值範圍:[1, 100],多個取值使用重複列表的形式,樣本 EventId.1="e-xhskHun1256xxxx" ,EventId.2="e-xhskHun1257xxxx" …… |
InstanceEventCycleStatus.N | String | 否 | 一個或者多個事件的生命週期狀態。N 的取值範圍:[1, 6],多個取值使用重複列表的形式,樣本 InstanceEventCycleStatus.1="Scheduled" ,InstanceEventCycleStatus.2="Canceled" ……。取值範圍:
|
EventCycleStatus | String | 否 | 事件的生命週期狀態。EventCycleStatus 只在未指定 InstanceEventCycleStatus.N 參數時有效。取值範圍:
|
InstanceEventType.N | String | 否 | 一個或者多個事件的類型。N 的取值範圍:[1, 30],多個取值使用重複列表的形式,樣本 InstanceEventType.1="Reboot" ,InstanceEventType.2="SystemFailure.Reboot" ……。取值範圍:
|
EventType | String | 否 | 事件的類型。EventType 參數只在未指定 InstanceEventType.N 參數時有效。取值範圍:
|
NotBefore.Start | String | 否 | 查詢事件計劃執行時間的開始時間。按照 ISO8601 標準表示,並需要使用 UTC 時間。格式為 YYYY-MM-DDTHH:mm:ssZ。 |
NotBefore.End | String | 否 | 查詢事件計劃執行時間的結束時間。按照 ISO8601 標準表示,並需要使用 UTC 時間。格式為 YYYY-MM-DDTHH:mm:ssZ。 |
EventPublishTime.Start | String | 否 | 查詢事件發布時間的開始時間。按照 ISO8601 標準表示,並需要使用 UTC 時間。格式為 YYYY-MM-DDTHH:mm:ssZ。 |
EventPublishTime.End | String | 否 | 查詢事件發布時間的結束時間。按照 ISO8601 標準表示,並需要使用 UTC 時間。格式為 YYYY-MM-DDTHH:mm:ssZ。 |
PageNumber | Integer | 否 | 查詢結果的頁碼。取值範圍:正整數 預設值:1 |
PageSize | Integer | 否 | 查詢結果的分頁大小。取值範圍:[1, 100] 預設值:10 |
返回參數
名稱 | 類型 | 描述 |
---|---|---|
TotalCount | Integer | 執行個體狀態總個數 |
PageNumber | Integer | 執行個體列表頁碼 |
PageSize | Integer | 輸入時設定的每頁行數 |
InstanceSystemEventSet | Array of InstanceSystemEventType | 執行個體曆史事件數目組 |
資料類型 InstanceSystemEventType
名稱 | 類型 | 描述 |
---|---|---|
InstanceId | String | 執行個體 ID |
EventId | String | 事件 ID |
EventType.Code | Integer | 事件類型代碼 |
EventType.Name | String | 事件類型名稱 |
EventCycleStatus.Code | Integer | 事件狀態碼 |
EventCycleStatus.Name | String | 事件狀態名稱 |
EventPublishTime | String | 事件發布時間。按照 ISO8601 標準表示,並使用 UTC 時間。格式為 YYYY-MM-DDTHH:mm:ssZ。 |
NotBefore | String | 事件計劃執行時間。按照 ISO8601 標準表示,並使用 UTC 時間。格式為 YYYY-MM-DDTHH:mm:ssZ。 |
EventFinishTime | String | 事件結束時間。按照 ISO8601 標準表示,並使用 UTC 時間。格式為 YYYY-MM-DDTHH:mm:ssZ。 |
樣本
請求樣本
https://ecs.aliyuncs.com/?Action=DescribeInstanceHistoryEvents
&RegionId=cn-hangzhou
&InstanceId=i-2ze3tphuqvc93cixxxx3
&<公共請求參數>
正常返回樣本
XML 格式
<DescribeInstanceHistoryEventsResponse>
<InstanceSystemEventSet>
<InstanceSystemEventType>
<InstanceId>i-2ze3tphuqvc93cixxxx3</InstanceId>
<EventId>e-2ze9yxxxxwtqcvai68rl</EventId>
<EventType>
<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 格式
{
"InstanceSystemEventSet": {
"InstanceSystemEventType": [
{
"InstanceId": "i-2ze3tphuqvc93cixxxx3",
"EventId": "e-2ze9yxxxxwtqcvai68rl",
"EventType": {
"Code": 1,
"Name": "SystemMaintenance.Reboot"
},
"EventCycleStatus": {
"Code": 0,
"Name": "Executed"
},
"EventPublishTime": "2017-11-30T06:32:31Z",
"NotBefore": "2017-12-01T06:32:31Z",
"EventFinishTime": "2017-12-01T06:35:31Z"
},
{
"InstanceId": "i-2ze3tphuqvc93cixxxx3",
"EventId": "e-2ze9yxxxxwtqcvai68r3",
"EventType": {
"Code": 34,
"Name": "InstanceExpiration.Stop"
},
"EventCycleStatus": {
"Code": 8,
"Name": "Avoided"
},
"EventPublishTime": "2017-11-29T06:32:31Z",
"NotBefore": "2017-12-06T00:00:00Z",
"EventFinishTime": "2017-12-05T12:35:31Z"
}
]
},
"PageSize": 10,
"PageNumber": 1,
"TotalCount": 2,
"RequestId": "02EA76D3-5A2A-44EB-XXXX-8901881D8707"
}
異常返回樣本
XML 格式
<Error>
<RequestId>C38E0D94-C18B-44F3-8C05-6E35BE334087</RequestId>
<HostId>ecs.aliyuncs.com</HostId>
<Code>InvalidParameter</Code>
<Message>The Parameter "EventCycleStatus" provided is not valid.</Message>
</Error>
JSON 格式
{
"RequestId": "1A8B4B27-8B2D-XXXX-XXXX-0F64DBE4C212",
"HostId": "ecs.aliyuncs.com"
"Code": "InvalidParameter"
"Message": "The Parameter "EventCycleStatus" provided is not valid."
}
錯誤碼
以下為本介面特有的錯誤碼。更多錯誤碼,請訪問 API 錯誤中心。
錯誤碼 | 錯誤資訊 | HTTP 狀態碼 | 說明 |
---|---|---|---|
InvalidParameter | The Parameter provided is not valid. | 403 | 請求參數不合法。 |
EventIdLimitExceeded | The amount of EventId specified exceeds limit 100. | 403 | 指定的 EventId 參數值個數不能超過 100 個。 |
MissingParameter | The input parameter that is mandatory for processing this request is not supplied. | 403 | 輸入的參數缺少必填項。 |
InternalError | The request processing has failed due to some unknown error, exception or failure. | 500 | 內部錯誤。 |