tencent cloud

DescribeDiskConfigQuota

Download
フォーカスモード
フォントサイズ
最終更新日: 2026-05-12 19:37:57

1. API Description

Domain name for API request: cbs.intl.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.

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 Params. The value used for this API: DescribeDiskConfigQuota.
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.
InquiryType Yes String INQUIRY type. valid values:
INQUIRY_CBS_CONFIG: query the cloud disk configuration list
INQUIRY_CVM_CONFIG: query the configuration list of cloud disks with instances.
DiskChargeType No String Billing mode. Value range:
  • POSTPAID_BY_HOUR: postpaid.
  • 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
    DiskTypes.N No Array of String Hard disk media type. valid values:
    CLOUD_BASIC: BASIC CLOUD disk
    CLOUD_PREMIUM: high-performance CLOUD block storage
    CLOUD_SSD: SSD CLOUD disk
    CLOUD_HSSD: enhanced SSD CLOUD disk.
    Zones.N No Array of String Query configuration under one or more availability zone.
    Memory No Integer Instance memory size in GB.
    DiskUsage No String SYSTEM DISK or DATA DISK. valid values:
    SYSTEM_DISK: SYSTEM DISK
    DATA_DISK: DATA DISK.
    CPU No Integer Instance CPU cores.
    DedicatedClusterId No String Dedicated cluster ID.

    3. Output Parameters

    Parameter Name Type Description
    DiskConfigSet Array of DiskConfig List of cloud disk configurations.
    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.

    4. Example

    Example1 Querying Available Specifications of High-Performance Cloud Block Storage in Shanghai Zone 5

    This example shows you how to query the available specifications of high-performance cloud block storage in Shanghai Zone 5.

    Input Example

    POST / HTTP/1.1
    Host: cbs.intl.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",
                    "Price": {
                        "DiscountPriceHigh": "81",
                        "DiscountPrice": 1.0,
                        "UnitPriceHigh": "1.00",
                        "UnitPriceDiscountHigh": "1.00",
                        "OriginalPriceHigh": "10",
                        "ChargeUnit": "H",
                        "OriginalPrice": 1.0,
                        "UnitPriceDiscount": 0.21,
                        "UnitPrice": 0.21
                    }
                }
            ],
            "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

    ヘルプとサポート

    この記事はお役に立ちましたか?

    フィードバック