查詢一台或多台執行個體的全狀態資訊。全狀態資訊包括執行個體狀態和執行個體事件狀態,其中,執行個體狀態為執行個體的生命週期狀態,執行個體事件為維護事件的健康狀態,更多詳情,請參閱 執行個體生命週期 和 執行個體系統事件。
描述
返回結果包括執行個體狀態和 待執行(Scheduled
) 狀態的執行個體系統事件。
如果指定一個時間段,則根據時間段篩選事件。
請求參數
名稱 | 類型 | 是否必需 | 描述 |
---|---|---|---|
Action | String | 是 | 系統規定參數。取值:DescribeInstancesFullStatus |
RegionId | String | 是 | 執行個體所在地域 ID。您可以調用 DescribeRegions 查看最新的阿里雲地域列表 |
InstanceId.N | String | 否 | 一台或者多台執行個體 ID。N 的取值範圍:[1, 100],多個取值使用重複列表的形式,樣本 InstanceId.1="i-instance1" ,InstanceId.2="i-instance2" …… |
EventId.N | String | 否 | 一個或者多個事件 ID。N 的取值範圍:[1, 100],多個取值使用重複列表的形式,樣本 EventId.1="e-xhskHun1256xxxx" ,EventId.2="e-xhskHun1257xxxx" …… |
Status | String | 否 | 指定執行個體的生命週期狀態。取值範圍:
|
HealthStatus | String | 否 | 指定執行個體的健康狀態。取值範圍:
|
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 | 每頁大小 |
InstanceFullStatusSet | Array of InstanceFullStatusType |
執行個體全狀態數組 |
資料類型 InstanceFullStatusType
名稱 | 類型 | 描述 |
---|---|---|
InstanceId | String | 執行個體 ID |
ScheduledSystemEventSet | Array of ScheduledSystemEventType |
系統計劃事件數目組 |
Status.Code | Integer | 執行個體生命週期狀態碼 |
Status.Name | String | 執行個體生命週期狀態名稱 |
HealthStatus.Code | Integer | 健康狀態碼 |
HealthStatus.Name | String | 健康狀態名稱 |
資料類型 ScheduledSystemEventType
名稱 | 類型 | 描述 |
---|---|---|
EventId | String | 執行個體事件 ID |
EventCycleStatus.Code | Integer | 事件狀態碼 |
EventCycleStatus.Name | String | 事件狀態名稱 |
EventType.Code | Integer | 事件類型代碼 |
EventType.Name | String | 事件類型名稱 |
EventPublishTime | String | 事件的發布時間。按照 ISO8601 標準表示,並使用 UTC 時間。格式為 YYYY-MM-DDTHH:mm:ssZ |
NotBefore | String | 事件的計劃執行時間。按照 ISO8601 標準表示,並使用 UTC 時間。格式為 YYYY-MM-DDTHH:mm:ssZ |
樣本
請求樣本
https://ecs.aliyuncs.com/?Action=DescribeInstancesFullStatus
&RegionId=cn-hangzhou
&<公共請求參數>
正常返回樣本
XML 格式
<DescribeInstancesFullStatusResponse>
<?xml version="1.0" encoding="UTF-8" ?>
<InstanceFullStatusSet>
<InstanceFullStatusType>
<InstanceId>i-instance1</InstanceId>
<Status>
<Code>1</Code>
<Name>Running</Name>
</Status>
<HealthStatus>
<Code>0</Code>
<Name>Ok</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 格式
{
"InstanceFullStatusSet": {
"InstanceFullStatusType": [
{
"InstanceId": "i-instance1",
"Status": {
"Code": 1,
"Name": "Running"
},
"HealthStatus": {
"Code": 0,
"Name": "Ok"
},
"ScheduledSystemEventSet": {
"ScheduledSystemEventType": [
{
"EventId": "e-event1",
"EventCycleStatus": {
"Code": 24,
"Name": "Scheduled"
},
"EventType": {
"Code": 1,
"Name": "SystemMaintenance.Reboot"
},
"EventPublishTime": "2017-11-30T06:32:31Z",
"NotBefore": "2017-12-01T06:32:31Z"
},
{
"EventId": "e-event2",
"EventCycleStatus": {
"Code": 24,
"Name": "Scheduled"
},
"EventType": {
"Code": 34,
"Name": "InstanceExpiration.Stop"
},
"EventPublishTime": "2017-11-30T00:00:00Z",
"NotBefore": "2017-12-07T00:00:00Z"
}
]
}
},
{
"InstanceId": "i-instance2",
"Status": {
"Code": 1,
"Name": "Running"
},
"HealthStatus": {
"Code": 64,
"Name": "Warning"
},
"ScheduledSystemEventSet": {
"ScheduledSystemEventType": [
{
"EventId": "e-event3",
"EventCycleStatus": {
"Code": 24,
"Name": "Scheduled"
},
"EventType": {
"Code": 65,
"Name": "SystemFailure.Reboot"
},
"EventPublishTime": "2017-11-30T06:32:31Z",
"NotBefore": "2017-12-01T06:32:31Z"
}
]
}
}
]
},
"PageSize": 10,
"PageNumber": 1,
"TotalCount": 2,
"RequestId": "AAC49D3E-ED6F-4F00-XXXX-377C551B1DD4"
}
異常返回樣本
XML 格式
<Error>
<RequestId>C38E0D94-C18B-44F3-8C05-6E35BE334088</RequestId>
<HostId>ecs.aliyuncs.com</HostId>
<Code>InstanceIdLimitExceeded</Code>
<Message>The amount of InstanceId specified exceeds limit 100.</Message>
</Error>
JSON 格式
{
"RequestId": "1A8B4B27-8B2D-XXXX-XXXX-0F64DBE4C213",
"HostId": "ecs.aliyuncs.com"
"Code": "InstanceIdLimitExceeded"
"Message": "The amount of InstanceId specified exceeds limit 100."
}
錯誤碼
以下為本介面特有的錯誤碼。更多錯誤碼,請訪問 API 錯誤中心。
錯誤碼 | 錯誤資訊 | HTTP 狀態碼 | 說明 |
---|---|---|---|
InvalidParameter | The Parameter provided is not valid. | 403 | 請求參數不合法。 |
EventIdLimitExceeded | The amount of EventId specified exceeds limit 100. | 403 | 指定的 EventId 參數值個數超出了合法範圍。 |
InstanceIdLimitExceeded | The amount of InstanceId specified exceeds limit 100. | 403 | 指定的 InstanceId 參數值個數超出了合法範圍。 |
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 | 內部錯誤。 |