# DescribeInstancesStatus

## 1. 接口描述

本接口(DescribeInstancesStatus)用于查询实例的状态。

## 2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

| 参数名称            | 必选 | 类型              | 描述                       |
| --------------- | -- | --------------- | ------------------------ |
| instanceIds     | 否  | Array of String | 要查询的实例ID列表。              |
| pageSize        | 否  | Integer         | 分页大小。                    |
| pageNum         | 否  | Integer         | <p>分页页数。</p><p>默认值：1</p> |
| resourceGroupId | 否  | String          | 根据资源组ID过滤。               |

## 3. 响应结果

| 参数名称       | 类型                                                                                                                 | 描述                                                       |
| ---------- | ------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------- |
| requestId  | String                                                                                                             | <p>唯一请求 ID。</p><p>每次请求都会返回。定位问题时需要提供该次请求的 requestId。</p> |
| totalCount | Integer                                                                                                            | 符合条件的数据总数。                                               |
| dataSet    | Array of [InstanceStatus](https://docs.console.zenlayer.com/api-reference/cn/compute/datastructure#instancestatus) | 实例状态数据。                                                  |

## 4. 代码示例

{% tabs %}
{% tab title="示例" %}
**1. 查询实例状态。**

```json
POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeInstancesStatus
<Common Request Params>

Request：
{}

Response：
{
  "requestId":"TDD2B967A-10DD-4876-939D-E5C637F768DE",
  "dataSet":[
    {
      "instanceId":"instanceId1",
      "instanceStatus":"RUNNING"
    },
    {
      "instanceId":"instanceId2",
      "instanceStatus":"STOPPED"
    },
    {
      "instanceId":"instanceId3",
      "instanceStatus":"RUNNING"

    }
  ],
  "totalCount":3
}
```

{% endtab %}
{% endtabs %}

## 5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的[开发工具集（SDK）](https://docs.console.zenlayer.com/api-reference/cn/api-introduction/toolkit)，未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

## 6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见[公共错误码](https://docs.console.zenlayer.com/api-reference/cn/api-introduction/instruction/commonerrorcode)

| HTTP状态码 | 错误码 | 说明 |
| ------- | --- | -- |