DescribeInstanceStatus - 查询实例的状态信息列表 - 云服务器 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）、读取（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.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。