DescribeInstances

1. API Description

This API (DescribeInstances) is used to query the details of instances. You can filter the query results with the instance ID, name, or billing method.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
instanceIds	No	Array of String	Instance IDs. You can query up to 100 instances in each request.
zoneId	No	String	Zone ID to which the instances belong.
imageId	No	String	Image ID.
ipv4Address	No	String	IPv4 addresses.
ipv6Address	No	String	IPv6 addresses.
status	No	InstanceStatusValue	Instance status.
name	No	String	Instance name.
pageSize	No	Integer	Number of items in the current page result. Maximum value: 1000. Default value: 20
pageNum	No	Integer	Number of pages returned. Default value: 1
resourceGroupId	No	String	Resource Group ID.
tagKeys	No	Array of String	Query using tag keys. A maximum of 20 tag keys can be used.
tags	No	Array of Tag	Query using tags. A maximum of 20 tags can be used.

3. Output Parameters

Parameter Name	Type	Description
requestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.
totalCount	Integer	Number of instances meeting the filtering conditions.
dataSet	Array of InstanceInfo	Information on an instance.

4. Code Example

Example

Query list of elastic compute instances.

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": "TFA4FD1A1-41B6-4BA7-A408-1D654A3E0D36",
  "response": {
      "requestId": "TFA4FD1A1-41B6-4BA7-A408-1D654A3E0D36",
      "totalCount": 1,
      "dataSet": [
          {
              "subnetId": "<subnetId>",
              "memory": 2,
              "instanceName": "instance",
              "enableIpForward": true,
              "keyId": "key-7K9AcYWv",
              "securityGroupId": "<securityGroupId>",
              "instanceId": "<instanceId>",
              "nics": [
                  {
                      "subnetId": "<subnetId>",
                      "resourceGroup": {
                          "resourceGroupName": "Default Resource Group",
                          "resourceGroupId": "<resourceGroupId>"
                      },
                      "primaryIpv4": "10.130.0.2",
                      "privateIpList": ["10.130.0.2"],
                      "nicSubnetType": "IPv4",
                      "updateTime": "2025-07-16T01:26:39Z",
                      "primaryIpv6": null,
                      "publicIpList": [],
                      "securityGroupId": "<securityGroupId>",
                      "ipv6Cidr": null,
                      "macAddress": "52:54:00:2f:a7:ec",
                      "instanceId": "<instanceId>",
                      "regionId": "asia-east-1",
                      "createTime": "2025-07-16T01:26:39Z",
                      "nicType": "Primary",
                      "vpcId": "<vpcId>",
                      "name": "Primary-Nic-asia-east-1-01",
                      "nicId": "<nicId>",
                      "status": "USED",
                      "secondaryIpv4s": [],
                      "tags":null
                  }
              ],
              "zoneId": "asia-east-1a",
              "resourceGroupId": "<resourceGroupId>",
              "nicNetworkType": "VirtioOnly",
              "privateIpAddresses": ["10.130.0.2"],
              "imageId": "<imageId>",
              "imageName": "<imageName>",
              "resourceGroupName": "Default Resource Group",
              "systemDisk": {
                  "diskSize": 20,
                  "diskId": "<diskId>",
                  "diskCategory": "<diskCategory>"
              },
              "instanceType": "z2a.cpu.1",
              "cpu": 1,
              "timeZone": "Asia/Shanghai",
              "enableAgent": true,
              "expiredTime": null,
              "publicIpAddresses": ["128.0.0.2"],
              "createTime": "2025-05-01T01:01:01Z",
              "dataDisks": null,
              "enableAgentMonitor": true,
              "status": "RUNNING",
              "tags":null,
              "loadBalancerIds":["yourLoadBalancerId1","yourLoadBalancerId2"]
          }
      ]
  }
}

5. Developer Resources

Zenlayer Cloud API 2.0 integrates SDKs，to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

HTTP Status Code	Error Code	Description