> For the complete documentation index, see [llms.txt](https://docs.console.zenlayer.com/api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.console.zenlayer.com/api-reference/cn/legacy/vm/virtual-machine-instance/describeinstancesstatus.md).

# DescribeInstancesStatus

## 1. 接口描述

本接口(DescribeInstancesStatus)用于查询一台或多台虚拟机实例的状态。

## 2. 请求参数

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

| 参数名称        | 必选 | 类型              | 描述                         |
| ----------- | -- | --------------- | -------------------------- |
| instanceIds | 否  | Array of String | 实例ID集合。                    |
| pageSize    | 否  | Integer         | 返回的分页大小。                   |
| pageNum     | 否  | Integer         | <p>返回的分页数。</p><p>默认值：1</p> |

## 3. 响应结果

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

## 4. 代码示例

{% tabs %}
{% tab title="示例" %}
**1. 分页查询实例列表**

```json
POST /api/v2/vm 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）](/api-reference/cn/api-introduction/toolkit.md)，未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

## 6. 错误码

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

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