Querying Dedicated Cluster Details
Updated at：2025-10-20
This API is used to retrieve detailed information about a single dedicated cluster based on its dedicated cluster ID.
Request structure
Plain Text
1GET /v{version}/volume/cluster/{clusterId} 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 |
| clusterId | String | Yes | URL parameter | Dedicated cluster ID |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| clusterId | String | Dedicated cluster ID |
| clusterName | String | Dedicated cluster name, which supports uppercase and lowercase letters, numbers, Chinese characters, and -_ /. special characters, starting with a letter and a length of 1-65. |
| createdTime | String | Creation date, compliant with BCE date specifications |
| expiredTime | String | The expiration time, formatted according to the BCE date specification. |
| status | String | Dedicated cluster status |
| logicalZone | String | Dedicated cluster type |
| productType | String | Payment type of dedicated cluster |
| clusterType | String | Dedicated cluster type |
| totalCapacity | int | Total capacity of dedicated cluster |
| usedCapacity | int | Used capacity of dedicated cluster |
| availableCapacity | int | Used capacity of dedicated cluster |
| expandingCapacity | int | Extended capacity of dedicated cluster |
| createdVolumeNum | int | Count of CDS created by the dedicated cluster |
| affiliatedCDSNumber | List of CDS created by the dedicated cluster | |
| enableAutoRenew | boolean | Whether to enable automatic payment |
| tags | List<[TagModel](BCC/API Reference/Appendix.md#TagModel)> | List of bound tags |
Request example
Plain Text
1GET /v2/volume/cluster/DC-bsVqFe6j HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/*****Response example
Plain Text
1 HTTP/1.1 200 OK
2 x-bce-request-id: 0cf8ea06-92be-47df-bd5f-34cab433a079
3 Date: Mar, 21 Dec 2023 06:42:19 GMT
4 Content-Type: application/json;charset=UTF-8
5 Server: BWS
6
7 {
8 "clusterId": "DC-bsVqFe6j",
9 "clusterName": "dbsc",
10 "createdTime": "2022-04-13T07:36:25Z",
11 "expiredTime": "2022-10-13T07:36:59Z",
12 "status": "preparing",
13 "logicalZone": "zoneA",
14 "productType": "prepay",
15 "clusterType": "hdd",
16 "totalCapacity": 97280,
17 "usedCapacity": 0,
18 "availableCapacity": 97280,
19 "expandingCapacity": 0,
20 "createdVolumeNum": 2,
21 "affiliatedCDSNumber": [
22 "v-MmbIhBqv",
23 "v-siPBYlT2"
24 ],
25 "enableAutoRenew": false，
26 "tags": [
27 {
28 "tagKey": "key1",
29 "tagValue": "value1"
30 }
31 ]
32 }