Domain name for API request: cbs.intl.tencentcloudapi.com.
This API is used to query the list of dedicated cloud disk clusters under the current user account.
CdcId) and availability zone (zone). Multiple filters are combined with AND. For details about filtering, please see Filter.Limit; the default is 20) of dedicated cloud disk clusters are returned.A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeDiskStoragePool. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| Limit | No | Integer | Number of returned results, defaults to 20 with a maximum value of 100. For further introduction about Limit, see relevant sections in the API overview. |
| CdcIds.N | No | Array of String | Specify the exclusive cluster ID list you want to query. This parameter cannot be used with Filters. |
| Filters.N | No | Array of Filter | Filter conditions. CdcIds and Filters cannot be specified at the same time. CLOUD_BASIC: HDD cloud disk |
| Offset | No | Integer | Offset, defaults to 0. For further introduction about CLOUD_PREMIUM, see the relevant sections in the API overview. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | the number of eligible dedicated clusters. |
| CdcSet | Array of Cdc | Details of the dedicated cluster. |
| DiskStoragePoolSet | Array of Cdc | Exclusive cluster details list. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to query the exclusive clusters you own for some users in finance who have exclusive requirements for cbs clusters using this API.
POST / HTTP/1.1
Host: cbs.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDiskStoragePool
<Common request parameters>
{
"Filters": [
{
"Name": "cdc-id",
"Values": [
"cdc-6brr1cvj"
]
}
]
}
{
"Response": {
"TotalCount": 1,
"RequestId": "2ed78bbb-c62b-4a93-8a97-a614ed9ef7e0",
"DiskStoragePoolSet": [],
"CdcSet": [
{
"CageId": "cdc-6brr1cvj",
"CdcState": "NORMAL",
"Zone": "ap-chongqing-1",
"CdcName": "untitled",
"CdcResource": {
"DiskTotal": 10
},
"CdcId": "cdc-xxx",
"DiskType": "CLOUD_SSD",
"DiskNumber": 135,
"ExpiredTime": "2022-02-25 15:59:15",
"CreatedTime": "2022-01-25T15:59:15+00:00"
}
]
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InvalidFilter | The specified Filter is not supported. |
| InvalidParameter | Incorrect parameter. |
| MissingParameter | Missing parameter. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback