Query the disk list
Updated at：2025-10-20
This API retrieves information on all disks except local disks.
Request structure
Plain Text
1GET /v{version}/volume?marker={marker}&maxKeys={maxKeys}&instanceId={instanceId} HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization stringRequest 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 | The maximum number of items per page is 1,000, with a default value of 1,000. |
| instanceId | String | No | Query | Instance ID: Retrieves the list of disks attached to the instance (including the system disk). Leave this parameter empty to view all disk details created by the user. |
| zoneName | String | No | Query | Availability zone information |
| clusterId | String | No | Query | CDS dedicated cluster ID |
| chargeFilter | String | No | Query | CDS billing type: value options are postpay/prepay |
| usageFilter | String | No | Query | CDS disk type: value options are system/data |
| name | String | No | Query | CDS disk name |
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" means there is more data available, and "False" means this is the last page. |
| nextMarker | String | The marker value needed to retrieve the next page. This field does not appear if isTruncated is false. |
| maxKeys | int | Maximum number of items included per page |
| volumes | List<[VolumeModel](BCC/API Reference/Appendix.md#VolumeModel)> | Returned disk information list |
Request example
Plain Text
1GET /v2/volume?marker=v-8CM91d5U&maxKeys=1&instanceId=i-j7lMWiyX HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1deResponse example
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Cache-Control: no-cache
4Content-Length: 17527
5Content-Type: application/json;charset=UTF-8
6Date: Wed, 08 Jul 2015 03:38:06 GMT
7Server: BWS
8
9 {
10 "nextMarker": "v-w7RKfn2d",
11 "marker": "v-8CM91d5U",
12 "maxKeys": 1,
13 "volumes": [
14 {
15 "id": "v-8CM91d5U",
16 "createTime": "2015-06-25T12:48:29Z",
17 "expireTime": null,
18 "name": "instance-0svq10tr-1",
19 "diskSizeInGB": 20,
20 "status": "InUse",
21 "type": "Cds",
22 "storageType": "hp1",
23 "desc": "",
24 "paymentTiming": "Postpaid",
25 "attachments": [
26 {
27 "volumeId": "v-3zmCcxbR",
28 "instanceId": "i-j7lMWiyX",
29 "device": "/dev/vdb"
30 "serial":"062b3f5d-b8a5-4c29-9"
31 }
32 ],
33 "zoneName": "cn-bj-a"
34 }
35 ],
36 "truncated": true
37 }