調用DescribeInstancesFullStatus查詢一臺或多臺ECS實例的全狀態信息。全狀態信息包括實例狀態和實例系統事件狀態,其中,實例狀態為實例的生命周期狀態,實例系統事件為維護事件的健康狀態。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀?。≧ead)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
ecs:DescribeInstancesFullStatus | list | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 實例所在地域 ID。您可以調用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
Status | string | 否 | 指定實例的生命周期狀態。取值范圍:
| Running |
HealthStatus | string | 否 | 指定實例的健康狀態。取值范圍:
以上參數取值均區分大小寫。 | OK |
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。 | |
string | 否 | 實例 ID。 | i-bp67acfmxazb4p**** | |
EventId | array | 否 | 事件 ID 列表??奢斎胱疃?100 個事件 ID。 | |
string | 否 | 事件 ID。 | e-bp1hygp5b04o56l0**** | |
InstanceEventType | array | 否 | 實例事件的類型列表。可輸入最大 30 個實例事件的類型。 | |
string | 否 | 實例系統事件的類型。取值范圍:
說明
事件類型說明請參見系統事件概述。該參數的取值只能是實例系統事件,不能是磁盤系統事件。
| SystemMaintenance.Reboot |
返回參數
示例
正常返回示例
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
}
}
]
}
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
403 | InvalidParameter | %s | 無效的參數。 |
403 | InvalidParameter.TimeEndBeforeStart | %s | 您輸入的參數無效,請確認結束時間是否早于開始時間。 |
403 | OperationDenied.NotInWhiteList | %s | 該操作無效,請先加入白名單。 |
403 | InstanceIdLimitExceeded | %s | 指定的 InstanceId 個數不能超過 100 個。 |
403 | EventIdLimitExceeded | %s | 一次最多能指定100個模擬事件ID。 |
404 | MissingParameter | %s | 缺失參數,請檢查參數是否完整。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-12-05 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-12-03 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |