DescribeInstances

1. 接口描述

本接口用于查询一台或多台虚拟机实例的信息。用户可以根据实例ID、实例名称等条件来查询实例的详细信息。

2. 请求参数

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

参数名称	必选	类型	描述
instanceIds	否	Array of String
zoneId	否	String	实例所属的可用区ID。
imageId	否	String	镜像ID。
ipv4Address	否	String	根据实例关联的IPv4过滤。
ipv6Address	否	String	根据实例关联的IPv6信息过滤。
status	否	InstanceStatusValue	根据实例的状态过滤。
name	否	String	根据实例显示名称过滤。 该字段支持模糊搜索。
pageSize	否	Integer	返回的分页大小。 默认值：20。
pageNum	否	Integer	返回的分页数。
resourceGroupId	否	String	根据资源组ID过滤。

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID。 每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
totalCount	Integer
dataSet	Array of InstanceInfo

4. 代码示例

示例

1. 查询虚拟机实例列表

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

Request:
{
  "instanceIds": ["xxx"],
  "pageSize": 10,
  "pageNum": 1
}

Response:
{
  "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
  "response": {
    "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
    "totalCount": 10,
    "dataSet": [
      {
        "instanceId": "xxx",
        "instanceName": "xxx",
        "zoneId": "xxx",
        "cpu": 1,
        "memory"：2,
        "imageId": "xxx",
        "imageName": "xxx",
        "status": "xxx",
        "systemDisk": {
          "diskId": "xxx",
          "diskSize": 1,
          "diskCategory": "xxx"
        },
        "dataDisks": [
          {
            "diskId": "xxx",
            "diskName": "xxx",
            "diskSize": 1,
            "portable": true,
          }
        ],
        "nics": [
          {
              "publicIpList": [
                  "128.0.0.1"
              ],
              "subnetId": "<subnet-id>",
              "instanceId": "<instance-id>",
              "regionId": "asia-east-1",
              "createTime": "2025-07-16T01:26:39Z",
              "nicType": "Primary",
              "vpcId": "<vpc-id>",
              "name": "Primary-Nic-asia-east-1-01",
              "privateIpList": [
                  "10.0.0.2"
              ],
              "nicSubnetType": "IPv4",
              "nicId": "<nic-id>",
              "status": "USED"
          }
        ],
        "publicIpAddresses": ["xxx"],
        "privateIpAddresses": ["xxx"],
        "keyId": "xxx",
        "createTime": "xxx",
        "expiredTime": "xxx",
        "resourceGroupId": "xxx",
        "resourceGroupName": "xxx"
      }
    ]
  }
}

5. 开发者工具

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

6. 错误码

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