本接口主要用于查詢一臺或多臺指定ECS實例的狀態信息，同時支持查詢指定條件下的實例列表。
接口說明
ECS 實例的生命周期狀態請參見實例狀態表。
請求示例
- 根據指定地域查詢實例以及狀態信息，入參示例：
"RegionID": "cn-hangzhou"
- 根據指定地域下的某個可用區查詢實例以及狀態信息，入參示例：
"RegionID": "cn-hangzhou",
"ZoneID": "cn-hangzhou-a"
- 根據指定地域和實例 ID查詢實例對應狀態信息，入參示例：
"RegionID": "cn-hangzhou",
"InstancesID": ["i-bp1f7c1zqp999zvp****", "i-bp1dqjv36biueg61****"]
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| ecs:DescribeInstanceStatus | get | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 實例所屬的地域 ID。您可以調用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| ZoneId | string | 否 | 實例所屬可用區。您可以調用 DescribeZones 查看最新的阿里云可用區列表。 | cn-hangzhou-d |
| ClusterId | string | 否 | 實例所屬的集群 ID。 注意 該參數已廢棄，不建議使用！ | cls-bp67acfmxazb4p**** |
| PageNumber | integer | 否 | 實例狀態列表的頁碼。 起始值：1。 默認值：1。 | 1 |
| PageSize | integer | 否 | 分頁查詢時設置的每頁行數。取值范圍：1~50。 默認值：10。 | 10 |
| InstanceId | array | 否 | 實例 ID 數組。數組長度：1~100。 示例值：["i-bp1j4i2jdf3owlhe****", "i-bp1j4i2jdf3o1234****"]。 | |
| string | 否 | 實例 ID。 | i-bp1j4i2jdf3owlhe**** |
返回參數
示例
正常返回示例
JSON格式
{
"PageSize": 1,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"PageNumber": 1,
"TotalCount": 58,
"InstanceStatuses": {
"InstanceStatus": [
{
"Status": "Running",
"InstanceId": "i-bp1j4i2jdf3owlhe****"
}
]
}
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 403 | InvalidParameter.TooManyInstanceIds | Instance ids cannot be more than 100. | - |
| 403 | Abs.InvalidInstanceIds.MalFormed | The specified instanceIds is not valid. | 指定的InstanceId參數不合法 |
| 404 | InvalidZoneId.NotFound | The ZoneId provided does not exist in our records. | 指定的可用區 ID 不存在。 |
訪問錯誤中心查看更多錯誤碼。