DescribeInstancesStatus

1. 接口描述

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

  • 如果参数为空, 则返回当前用户一定数量(pageSize所指定的数量,默认为20)的实例状态

2. 请求参数

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

参数名称必选类型描述

instanceIds

Array of String

实例ID。

最多支持100个ID查询。

pageSize

Integer

返回的分页大小。

默认为20,最大为1000。

pageNum

Integer

返回的分页数。

默认为1。

3. 响应结果

参数名称类型描述

requestId

String

唯一请求 ID。

每次请求都会返回。定位问题时需要提供该次请求的 requestId。

totalCount

Integer

符合条件的数据总数。

dataSet

实例状态列表。

4. 代码示例

  1. 分页查询实例列表

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
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集(SDK),未来会陆续支持更多开发语言,方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码,其他错误码见公共错误

HTTP状态码错误码说明

最后更新于