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.
resourceGroupId	No	String	Resource group ID. If the value is null, then return all the instances in the authorized resource groups.
instanceTypeId	No	String	Instance model ID. You can call DescribeInstanceTypes to obtain the latest specification.
internetChargeType	No	String	Network pricing model. See InternetChargeType for details.
imageId	No	String	Image ID.
subnetId	No	String	Subnet ID. You can call DescribeVpcSubnets to query information on subnet.
instanceStatus	No	String	Instance status. See InstanceStatus for details.
instanceName	No	String	Instance name. If the value ends with *, a fuzzy match will be performed on instanceName, otherwise an exact match will be performed.
hostname	No	String	Instance hostname. If the value ends with *, a fuzzy match will be performed on hostname, otherwise an exact match will be performed.
publicIpAddresses	No	Array of String	List of public IPs of the instance.
privateIpAddresses	No	Array of String	List of private IPs of the instance.
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

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

Request:
{
  "pageNum": 1,
  "pageSize": 1
}

Response:
{
  "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
  "response": {
    "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
    "totalCount": 6,
    "dataSet": [
      {
        "instanceId": "instanceId",
        "zoneId": "HKG-A",
        "instanceName": "TEST",
        "hostname": "M7D-HKG-A-01",
        "instanceTypeId": "M7D",
        "imageId": "imageId",
        "imageName": "Ubuntu18.04-x86_64",
        "instanceChargeType": "POSTPAID",
        "bandwidthOutMbps": 0,
        "internetChargeType": "ByClusterBandwidth95",
        "period": null,
        "primaryPublicIpAddress": "1.1.1.1",
        "publicIpAddresses": [
          "1.1.1.1",
          "2.2.2.2"
        ],
        "privateIpAddresses": [
          "10.0.0.1"
        ],
        "ipv6Addresses": [
          "2602:ffe4:1:11::1"
        ],
        "subnetIds": [
          "subnetId"
        ],
        "createTime": "2023-01-01T00:00:00Z",
        "expiredTime": null,
        "resourceGroupId": "resourceGroupId",
        "instanceStatus": "RUNNING",
        "trafficPackageSize": 1.5,
        "raidConfig": {
          "raidType": null,
          "customRaids": [
            {
              "raidType": 1,
              "diskSequence": [
                12,
                13
              ]
            }
          ]
        },
        "partitions": [
          {
            "fsPath": "/",
            "fsType": "ext2",
            "size": 1100
          }
        ],
        "nic": {
          "wanName": "wan0",
          "lanName": "lan0"
        },
        "autoRenew": true
      }
    ]
  }
}

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
404	IMAGE_NOT_FOUND	Image not found.
404	INVALID_ZONE_NOT_FOUND	Zone not found.
404	INVALID_INSTANCE_TYPE_NOT_FOUND	Instance type not found.