Querying Dedicated Cluster List
Updated at：2025-10-20
This API is used to retrieve information regarding the list of dedicated clusters.
Request structure
Plain Text
1GET /v{version}/volume/cluster 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. |
| clusterName | String | No | Query | The name of the dedicated cluster being queried |
| zoneName | String | No | Query | Availability zone information |
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 |
| result | List<[VolumeClusterModel](BCC/API Reference/Appendix.md#VolumeClusterModel)> | Returned disk information list |
Request example
Plain Text
1 GET /v2/volume/cluster HTTP/1.1
2 Host: bcc.bj.baidubce.com
3 Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/*****Response example
Plain Text
1 HTTP/1.1 200 OK
2 x-bce-request-id: b9ed9312-bddf-4d86-95cc-ae1f121fa787
3 Date: Mar, 21 Dec 2023 06:42:19 GMT
4 Content-Type: application/json;charset=UTF-8
5 Server: BWS
6
7 {
8 "result": [
9 {
10 "clusterId": "DC-aax07twB",
11 "clusterName": "dbsc-5pEZ5ol2",
12 "createdTime": "2022-08-18T11:44:14Z",
13 "expiredTime": "2023-02-18T11:45:05Z",
14 "status": "preparing",
15 "logicalZone": "zoneB",
16 "productType": "prepay",
17 "clusterType": "hp1",
18 "totalCapacity": 97280,
19 "usedCapacity": 0,
20 "availableCapacity": 97280,
21 "expandingCapacity": 0,
22 "createdVolumeNum": 0,
23 "enableAutoRenew": false
24 }
25 ],
26 "marker": "",
27 "isTruncated": false,
28 "nextMarker": null,
29 "maxKeys": 1000
30 }