Query the Instance List
Last Updated：2020-07-20
Query all instance details.
Request Structure
GET /v{version}/instance?marker={marker}&maxKeys={maxKeys}&internalIp={internalIp}&dedicatedHostId={dedicatedHostId}&zoneName={zoneName} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization stringRequest Header Field
There are no other special header fields except the public header field.
Request Parameters
| Parameter Name | Type | Required？ | Parameter Position | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| marker | String | No | Query parameters | The start position of query to obtain the list by batch, which is a character string generated by the system. |
| maxKeys | int | No | Query parameter | Maximum number of master instances per page, which usually does not exceed 1,000, and the default value is 1,000. |
| internalIp | String | No | Query parameter | Private IP |
| dedicatedHostId | String | No | Query parameter | Dedicated Cloud Compute (DCC)id |
| zoneName | String | No | Query parameter | Availability zone information |
Return Header Field
There are no other special header fields except the common header field.
Return Parameter
| Parameter Name | Type | Description |
|---|---|---|
| marker | String | Mark the starting position of the query |
| isTruncated | boolean | True means there is still data behind, and false means it is already the last page. |
| nextMarker | String | Get the marker value to be passed on the next page. This field does not appear when “isTruncated” is false. |
| maxKeys | int | Maximum number of master instances per page |
| instances | List<InstanceModel> | Instance information, a set of InstanceModels. |
Request Instance
GET /v2/instance?marker=i-IyWRtII7&maxKeys=1 HTTP/1.1
Host: bcc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1deReturn Instance
HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS
{
"nextMarker": "i-xktdeMSf",
"marker": "i-IyWRtII7",
"maxKeys": 1,
"isTruncated": true,
"instances": [
{
"id": "i-IyWRtII7",
"createTime": "2015-08-06T13:23:13Z",
"name": "instance-j93wzbn1",
"instanceType": "N1",
"status": "Running",
"desc": "console",
"paymentTiming":"Postpaid",
"expireTime": null,
"internalIp": "192.168.6.15",
"publicIp": "-",
"cpuCount": 1,
"memoryCapacityInGB": 1,
"localDiskSizeInGB": 0,
"networkCapacityInMbps": 1,
"imageId": "m-3zfBY1Ku",
"placementPolicy": "default",
"zoneName": "cn-bj-a"
}
]
}