DescribeDiskConfigQuota

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2021-01-22 10:39:09

Download PDF

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.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cbs.ap-shanghai-fsi.tencentcloudapi.com

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.

2. Input Parameters

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 parameter. The value used for this API: DescribeDiskConfigQuota.
Version	Yes	String	Common parameter. The value used for this API: 2017-03-12.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
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 configurations of cloud disks in Guangzhou Zone 2

This example shows you how to query the availability and configurations of cloud disks in an availability zone. If the value of Available is true in the response, there are available resources; if its value is false, the specified cloud disks are sold out.

Input Example

https://cbs.tencentcloudapi.com/?Action=DescribeDiskConfigQuota
&InquiryType=INQUIRY_CBS_CONFIG
&Zones.0=ap-guangzhou-2
&<Common request parameters>

Output Example

{
  "Response": {
    "DiskConfigSet": [
      {
        "Available": true,
        "DiskChargeType": "POSTPAID_BY_HOUR",
        "Zone": "ap-guangzhou-2",
        "InstanceFamily": null,
        "DiskType": "CLOUD_BASIC",
        "DeviceClass": null,
        "DiskUsage": "DATA_DISK",
        "MinDiskSize": 10,
        "MaxDiskSize": 4000
      },
      {
        "Available": true,
        "DiskChargeType": "POSTPAID_BY_HOUR",
        "Zone": "ap-guangzhou-2",
        "InstanceFamily": null,
        "DiskType": "CLOUD_PREMIUM",
        "DeviceClass": null,
        "DiskUsage": "DATA_DISK",
        "MinDiskSize": 50,
        "MaxDiskSize": 4000
      },
      {
        "Available": false,
        "DiskChargeType": "POSTPAID_BY_HOUR",
        "Zone": "ap-guangzhou-2",
        "InstanceFamily": null,
        "DiskType": "CLOUD_SSD",
        "DeviceClass": null,
        "DiskUsage": "DATA_DISK",
        "MinDiskSize": 100,
        "MaxDiskSize": 4000
      }
    ],
    "RequestId": "55db49cf-b9d7-da27-825b-5a02ba6814b2"
  }
}

Example2 Querying the configurations of cloud disks that are compatible with the S3 models in Guangzhou Zone 2

This example shows you how to query the compatible configurations of cloud disks for a specified instance model. If the value of Available is true in the response, the cloud disk is available; if its value is false, the specified resources are sold out.

Input Example

https://cbs.tencentcloudapi.com/?Action=DescribeDiskConfigQuota
&InquiryType=INQUIRY_CVM_CONFIG
&Zones.0=ap-guangzhou-2
&InstanceFamilies.0=S3
&<Common request parameters>

Output Example

{
  "Response": {
    "DiskConfigSet": [
      {
        "Available": true,
        "MaxDiskSize": 16000,
        "Zone": "ap-guangzhou-2",
        "InstanceFamily": "S3",
        "DiskType": "CLOUD_BASIC",
        "DeviceClass": "VSELF_3",
        "DiskUsage": "DATA_DISK",
        "MinDiskSize": 10,
        "DiskChargeType": "POSTPAID_BY_HOUR"
      },
      {
        "Available": true,
        "MaxDiskSize": 500,
        "Zone": "ap-guangzhou-2",
        "InstanceFamily": "S3",
        "DiskType": "CLOUD_BASIC",
        "DeviceClass": "VSELF_3",
        "DiskUsage": "SYSTEM_DISK",
        "MinDiskSize": 50,
        "DiskChargeType": "POSTPAID_BY_HOUR"
      },
      {
        "Available": true,
        "MaxDiskSize": 16000,
        "Zone": "ap-guangzhou-2",
        "InstanceFamily": "S3",
        "DiskType": "CLOUD_SSD",
        "DeviceClass": "VSELF_3",
        "DiskUsage": "DATA_DISK",
        "MinDiskSize": 100,
        "DiskChargeType": "POSTPAID_BY_HOUR"
      },
      {
        "Available": true,
        "MaxDiskSize": 500,
        "Zone": "ap-guangzhou-2",
        "InstanceFamily": "S3",
        "DiskType": "CLOUD_SSD",
        "DeviceClass": "VSELF_3",
        "DiskUsage": "SYSTEM_DISK",
        "MinDiskSize": 50,
        "DiskChargeType": "POSTPAID_BY_HOUR"
      }
    ],
    "RequestId": "55db49cf-b9d7-da27-825b-5a02ba6814b2"
  }
}

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

Tencent Cloud CLI 3.0

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.

Recent Pages