Query Instance List by Instance ID
Updated at:2025-10-20
This API allows querying a list of instances based on their instance IDs.
Request structure
Plain Text
1POST /v{version}/instance/listByInstanceId?marker={marker}&maxKeys={maxKeys} HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
4{
5 "instanceIds": [
6 "i-xktdeMSf", "i-IyWRtII7"
7 ]
8}
Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| marker | String | No | Query | The starting position of the batch list query is a system-generated string |
| maxKeys | int | No | Query | Maximum number of items per page: 1,000 (default: 1,000). |
| instanceIds | Yes | RequestBody | Supports querying a list of up to 100 instance IDs. |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| marker | String | Mark the starting position of the query. |
| isTruncated | boolean | true indicates there is more data later, false indicates it is the last page |
| nextMarker | String | The marker value needed to fetch the next page. This field is absent when isTruncated is false. |
| maxKeys | int | Maximum number of items included per page |
| instances | List<[InstanceModel](BCC/API Reference/Appendix.md#InstanceModel)> | Instance information comprised of InstanceModel |
Request example
Plain Text
1POST /v2/instance/listByInstanceId?marker=i-IyWRtII7&maxKeys=1 HTTP/1.1
2Host: bcc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
5{
6 "instanceIds": [
7 "i-xktdeMSf", "i-IyWRtII7"
8 ]
9}
Response example
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7{
8 "nextMarker": "i-xktdeMSf",
9 "marker": "i-IyWRtII7",
10 "maxKeys": 1,
11 "isTruncated": true,
12 "instances": [
13 {
14 "id": "i-IyWRtII7",
15 "createTime": "2015-08-06T13:23:13Z",
16 "name": "instance-j93wzbn1",
17 "instanceType": "N1",
18 "status": "Running",
19 "desc": "console",
20 "paymentTiming":"Postpaid",
21 "expireTime": null,
22 "internalIp": "192.168.6.15",
23 "publicIp": "-",
24 "cpuCount": 1,
25 "memoryCapacityInGB": 1,
26 "localDiskSizeInGB": 0,
27 "networkCapacityInMbps": 1,
28 "imageId": "m-3zfBY1Ku",
29 "placementPolicy": "default",
30 "zoneName": "cn-bj-a",
31 "autoRenew":"true"
32 }
33 ]
34}
