調用DescribeInstancesFullStatus查詢一台或多台ECS執行個體的全狀態資訊。全狀態資訊包括執行個體狀態和執行個體系統事件狀態,其中,執行個體狀態為執行個體的生命週期狀態,執行個體系統事件為維護事件的健康狀態。
介面說明
介面說明
返回結果包括執行個體狀態和待執行(Scheduled)狀態的執行個體系統事件。
如果指定一個時間段,則根據時間段篩選事件。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
ecs:DescribeInstancesFullStatus |
list |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
是 |
執行個體所在地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。 |
cn-hangzhou |
| RegionId |
string |
是 |
執行個體所在地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。 |
cn-hangzhou |
| Status |
string |
否 |
指定執行個體的生命週期狀態。取值範圍:
|
Running |
| HealthStatus |
string |
否 |
指定執行個體的健康狀態。取值範圍:
以上參數取值均區分大小寫。 |
Initializing |
| EventType |
string |
否 |
一個事件的類型。EventType 參數只在未指定 InstanceEventType.N 參數時有效。取值範圍:
|
InstanceExpiration.Stop |
| NotBefore.Start |
string |
否 |
查詢事件計劃執行時間的開始時間。按照ISO 8601標準表示,並需要使用 UTC 時間,格式為 yyyy-MM-ddTHH:mm:ssZ。 |
2017-12-07T00:00:00Z |
| NotBefore.End |
string |
否 |
查詢事件計劃執行時間的結束時間。按照ISO 8601標準表示,並需要使用 UTC 時間,格式為 yyyy-MM-ddTHH:mm:ssZ。 |
2017-11-30T00:00:00Z |
| EventPublishTime.Start |
string |
否 |
查詢事件發布時間的開始時間。按照ISO 8601標準表示,並需要使用 UTC 時間,格式為 yyyy-MM-ddTHH:mm:ssZ。 |
2017-11-30T00:00:00Z |
| EventPublishTime.End |
string |
否 |
查詢事件發布時間的結束時間。按照ISO 8601標準表示,並需要使用 UTC 時間,格式為 yyyy-MM-ddTHH:mm:ssZ。 |
2017-12-07T00:00:00Z |
| PageNumber |
integer |
否 |
查詢結果的頁碼。取值範圍:正整數 預設值:1。 |
1 |
| PageSize |
integer |
否 |
查詢結果的分頁大小。取值範圍:1~100。 預設值:10。 |
10 |
| InstanceId |
array |
否 |
執行個體 ID 列表。可輸入最大 100 個執行個體 ID。 |
i-bp67acfmxazb4p**** |
|
string |
否 |
執行個體 ID。 |
i-bp67acfmxazb4p**** |
|
| EventId |
array |
否 |
事件 ID 列表。可輸入最多 100 個事件 ID。 |
e-bp1hygp5b04o56l0**** |
|
string |
否 |
事件 ID。 |
e-bp1hygp5b04o56l0**** |
|
| InstanceEventType |
array |
否 |
執行個體事件的類型列表。可輸入最大 30 個執行個體事件的類型。 |
InstanceExpiration.Stop |
|
string |
否 |
執行個體系統事件的類型。取值範圍:
說明
事件類型說明請參見系統事件概述。該參數的取值只能是執行個體系統事件,不能是磁碟系統事件。 |
SystemMaintenance.Reboot |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| PageSize |
integer |
每頁大小。 |
1 |
| RequestId |
string |
請求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| PageNumber |
integer |
頁碼。 |
1 |
| TotalCount |
integer |
總條數。 |
2 |
| InstanceFullStatusSet |
object |
||
| InstanceFullStatusType |
array<object> |
執行個體全狀態數組。 說明
當執行個體不存在時該資料為空白。 |
|
|
array<object> |
|||
| InstanceId |
string |
執行個體 ID。 |
i-bp67acfmxazb4p**** |
| ScheduledSystemEventSet |
object |
||
| ScheduledSystemEventType |
array<object> |
目前狀態為 Scheduled 或 Inquiring 的系統事件數組。 |
|
|
array<object> |
|||
| EventPublishTime |
string |
事件的發布時間,使用 UTC+0 時間。 |
2017-11-30T06:32:31Z |
| EventId |
string |
執行個體事件 ID。 |
e-bp1hygp5b04o56l0**** |
| NotBefore |
string |
事件的計劃執行時間,使用 UTC+0 時間。 |
2017-12-07T00:00:00Z |
| ImpactLevel |
string |
影響層級。 說明
不在白名單的使用者,該參數為空白。 |
100 |
| Reason |
string |
系統事件的計劃原因。 說明
當阿里雲沒有判斷出異常原因時,該參數為空白。 |
A simulated event. |
| EventCycleStatus |
object |
事件狀態。 |
|
| Name |
string |
事件狀態名稱。 |
Scheduled |
| Code |
integer |
事件狀態碼。 |
24 |
| EventType |
object |
事件類型。 |
|
| Name |
string |
事件類型名稱。 |
SystemMaintenance.Reboot |
| Code |
integer |
事件類型代碼。 |
1 |
| ExtendedAttribute |
object |
本地碟執行個體系統事件拓展屬性。 不同事件類型,傳回值有所不同。 當事件類型不在以下列表中時,該資料為空白。
|
|
| Device |
string |
本地碟裝置名稱。 |
/dev/vdb |
| DiskId |
string |
本地碟磁碟 ID。 |
d-bp67acfmxazb4p**** |
| InactiveDisks |
object |
||
| InactiveDisk |
array<object> |
已釋放但需要清理的非活躍雲端硬碟或本地碟資訊。 |
|
|
object |
|||
| CreationTime |
string |
雲端硬碟或本地碟的建立時間。按照ISO 8601標準表示,使用 UTC 時間,格式為 yyyy-MM-ddTHH:mm:ssZ。 |
2018-07-27T13:53:25Z |
| DeviceSize |
string |
雲端硬碟或本地碟大小,單位 GiB。 |
80 |
| DeviceCategory |
string |
雲端硬碟或本地碟種類。可能值:
|
cloud_ssd |
| DeviceType |
string |
雲端硬碟或本地碟類型。可能值:
|
system |
| ReleaseTime |
string |
雲端硬碟或本地碟的釋放時間。按照ISO 8601標準表示,使用 UTC 時間,格式為 yyyy-MM-ddTHH:mm:ssZ。 |
2019-07-27T13:53:25Z |
| Status |
object |
執行個體生命週期狀態。 |
|
| Name |
string |
執行個體生命週期狀態名稱。 |
Running |
| Code |
integer |
執行個體生命週期狀態碼。 |
1 |
| HealthStatus |
object |
執行個體的健康狀態。 |
|
| Name |
string |
健康狀態名稱。 |
Warning |
| Code |
integer |
健康狀態碼。 |
64 |
樣本
正常返回樣本
JSON格式
{
"PageSize": 1,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"PageNumber": 1,
"TotalCount": 2,
"InstanceFullStatusSet": {
"InstanceFullStatusType": [
{
"InstanceId": "i-bp67acfmxazb4p****",
"ScheduledSystemEventSet": {
"ScheduledSystemEventType": [
{
"EventPublishTime": "2017-11-30T06:32:31Z",
"EventId": "e-bp1hygp5b04o56l0****",
"NotBefore": "2017-12-07T00:00:00Z",
"ImpactLevel": "100",
"Reason": "A simulated event.",
"EventCycleStatus": {
"Name": "Scheduled",
"Code": 24
},
"EventType": {
"Name": "SystemMaintenance.Reboot",
"Code": 1
},
"ExtendedAttribute": {
"Device": "/dev/vdb",
"DiskId": "d-bp67acfmxazb4p****",
"InactiveDisks": {
"InactiveDisk": [
{
"CreationTime": "2018-07-27T13:53:25Z",
"DeviceSize": "80",
"DeviceCategory": "cloud_ssd",
"DeviceType": "system",
"ReleaseTime": "2019-07-27T13:53:25Z"
}
]
}
}
}
]
},
"Status": {
"Name": "Running",
"Code": 1
},
"HealthStatus": {
"Name": "Warning",
"Code": 64
}
}
]
}
}
異常返回樣本
JSON格式
{
"InstanceFullStatusSet": {
"InstanceFullStatusType": [
{
"InstanceId": "i-instance1",
"Status": {
"Code": 1,
"Name": "Running"
},
"HealthStatus": {
"Code": 0,
"Name": "Maintaining"
},
"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"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 403 | InvalidParameter | %s | |
| 403 | InvalidParameter.TimeEndBeforeStart | %s | 您輸入的參數無效,請確認結束時間是否早於開始時間。 |
| 403 | OperationDenied.NotInWhiteList | %s | 該操作無效,請先加入白名單。 |
| 403 | InstanceIdLimitExceeded | %s | 指定的 InstanceId 個數不能超過 100 個。 |
| 403 | EventIdLimitExceeded | %s | |
| 404 | MissingParameter | %s |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。