1. API Description
Domain name for API request: cbs.tencentcloudapi.com.
This API (DescribeDiskConfigQuota) is used to query the cloud disk quota.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
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: DescribeDiskConfigQuota. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2017-03-12. |
| Region |
No |
String |
Common Params. This parameter is not required for this API. |
| InquiryType |
Yes |
String |
Inquiry type. Value range: INQUIRY_CBS_CONFIG: query the configuration list of cloud disks INQUIRY_CVM_CONFIG: query the configuration list of cloud disks and instances. |
| Zones.N |
No |
Array of String |
Query configuration under one or more availability zone. |
| DiskChargeType |
No |
String |
Billing mode. Value range: POSTPAID_BY_HOUR: postpaid. |
| DiskTypes.N |
No |
Array of String |
Cloud disk media type. Valid values: CLOUD_BASIC: HDD cloud disk CLOUD_PREMIUM: Premium Cloud Storage CLOUD_SSD: SSD CLOUD_HSSD: Enhanced SSD |
| DiskUsage |
No |
String |
The system disk or data disk. Value range: SYSTEM_DISK: System disk DATA_DISK: Data disk. |
| InstanceFamilies.N |
No |
Array of String |
Filter by the instance model series, such as S1, I1 and M1. For more information, please see Instance Types |
| CPU |
No |
Integer |
Instance CPU cores. |
| Memory |
No |
Integer |
Instance memory size. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| DiskConfigSet |
Array of DiskConfig |
List of cloud disk configurations. |
| RequestId |
String |
The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Querying the purchasable specifications of Premium Cloud Disk in Shanghai Zone 5
This example shows you how to query the purchasable specifications of Premium Cloud Disk in Shanghai Zone 5.
POST / HTTP/1.1
Host: cbs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDiskConfigQuota
<Common request parameters>
{
"InquiryType": "INQUIRY_CBS_CONFIG",
"DiskChargeType": "POSTPAID_BY_HOUR",
"Zones": [
"ap-shanghai-5"
],
"DiskTypes": [
"CLOUD_PREMIUM"
]
}
Output Example
{
"Response": {
"DiskConfigSet": [
{
"Available": true,
"MaxDiskSize": 32000,
"Zone": "ap-shanghai-5",
"InstanceFamily": null,
"DiskType": "CLOUD_PREMIUM",
"StepSize": 1,
"ExtraPerformanceRange": null,
"DeviceClass": null,
"DiskUsage": "DATA_DISK",
"MinDiskSize": 10,
"DiskChargeType": "PREPAID"
}
],
"RequestId": "50346458-c053-47f1-b60f-5507e7cc5b26"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code |
Description |
| InvalidParameterValue |
Invalid parameter value. |
| MissingParameter |
Missing parameter. |
| UnsupportedOperation |
Unsupported operation |