DescribeManagedInstances

1. API Description

This API is used to query the details of one or more instances. You can filter the query results with the instance ID, or name.

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.

instanceName

No

String

Instance name.

ip

No

String

Public IP address.

lanIp

No

String

Public IP address.

facName

No

String

Location name.

cityCode

No

String

City code.

pageNum

No

Integer

Number of pages returned.

Default value: 1

pageSize

No

Integer

Number of items in the current page result.

Default value: 20

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

Information on an instance.

4. Code Example

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

Request:
{
      "instanceIds": ["instanceId1","instanceId2"]
}

Response:
  {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
    "response": {
      "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
      "totalCount": 1,
      "dataSet": [
        {
          "instanceId": "instanceId1",
          "instanceName": "TEST",
          "facName": "example",
          "ips": [
            "1.1.1.1"
          ],
          "lanIps": [
            "192.168.0.1"
          ],
          "createTime": "2023-01-01T00:00:00Z"
        }
      ]
    }
  }

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.​

Last updated