DescribeInstances

1. API Description

This API 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.
status	No	String	Instance status. See InstanceStatusValue for details.
name	No	String	Instance name.
ipv4Address	No	String	IPv4 addresses.
ipv6Address	No	String	IPv6 addresses.
pageSize	No	Integer	Number of items in the current page result. Default value: 20; Maximum value: 1000.
pageNum	No	Integer	Number of pages returned. Default value: 1.

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": "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,
          }
        ],
        "publicIpAddresses": ["xxx"],
        "privateIpAddresses": ["xxx"],
        "keyId": "xxx",
        "createTime": "xxx",
        "expiredTime": "xxx",
        "resourceGroupId": "xxx",
        "resourceGroupName": "xxx"
      }
    ]
  }
}

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

No error codes related to the API business logic. For other error codes, see Common Error Codes.​