DescribeInstanceStatus - 查詢執行個體的狀態資訊列表 - Elastic Compute Service

介面說明

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）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ecs:DescribeInstanceStatus

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
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**"]。	i-bp1j4i2jdf3owlhe****
	string	否	執行個體 ID。	i-bp1j4i2jdf3owlhe****

返回參數

名稱	類型	描述	樣本值
	object
PageSize	integer	輸入時設定的每頁行數。	1
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	執行個體列表的頁碼。	1
TotalCount	integer	執行個體總個數。	58
InstanceStatuses	object
InstanceStatus	array<object>	執行個體 ID 和狀態（InstanceStatus）的集合。
	object
Status	string	執行個體狀態。可能值： Pending：建立中。 Running：運行中。 Starting：啟動中。 Stopping：停止中。 Stopped：已停止。	Running
InstanceId	string	執行個體 ID。	i-bp1j4i2jdf3owlhe****

樣本

正常返回樣本

JSON格式

{
  "PageSize": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 58,
  "InstanceStatuses": {
    "InstanceStatus": [
      {
        "Status": "Running",
        "InstanceId": "i-bp1j4i2jdf3owlhe****"
      }
    ]
  }
}

異常返回樣本

JSON格式

{
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"TotalCount": 2,
"PageNumber": 1,
"PageSize": 10,
"InstanceStatuses": {
    "InstanceStatus": [{
        "InstanceId": "i-instance1",
            "Status": "Running"
        },
        {
            "InstanceId": "i-ae4r89pp",
            "Status": "Stopped"
        }]
    }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
403	InvalidParameter.TooManyInstanceIds	Instance ids cannot be more than 100.	InstanceIds列表長度超過100。
403	Abs.InvalidInstanceIds.MalFormed	The specified instanceIds is not valid.	指定的InstanceId參數不合法
404	InvalidZoneId.NotFound	The ZoneId provided does not exist in our records.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。