API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > 云硬盘 > 云硬盘相关接口 > 查询云硬盘配额

查询云硬盘配额

最近更新时间：2024-03-12 01:12:41

我的收藏

本页目录：

1. 接口描述

接口请求域名： cbs.tencentcloudapi.com 。

本接口（DescribeDiskConfigQuota）用于查询云硬盘配额。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeDiskConfigQuota。
Version 是 String 公共参数，本接口取值：2017-03-12。
Region 是 String 公共参数，详见产品支持的 地域列表。
InquiryType 是 String 查询类别，取值范围。
  • INQUIRY_CBS_CONFIG：查询云盘配置列表
  • INQUIRY_CVM_CONFIG：查询云盘与实例搭配的配置列表。
    示例值：INQUIRY_CVM_CONFIG
    		•
    DiskChargeType 否 String 付费模式。取值范围：
  • PREPAID：预付费
  • POSTPAID_BY_HOUR：后付费。
    示例值：POSTPAID_BY_HOUR
    		•
    InstanceFamilies.N 否 Array of String 按照实例机型系列过滤。实例机型系列形如：S1、I1、M1等。详见实例类型
    示例值：["S3"]
    DiskTypes.N 否 Array of String 硬盘介质类型。取值范围：
  • CLOUD_BASIC：表示普通云硬盘
  • CLOUD_PREMIUM：表示高性能云硬盘
  • CLOUD_SSD：表示SSD云硬盘
  • CLOUD_HSSD：表示增强型SSD云硬盘。
    示例值：["CLOUD_PREMIUM"]
    		•
    Zones.N 否 Array of String 查询一个或多个可用区下的配置。
    示例值：["ap-guangzhou-7"]
    Memory 否 Integer 实例内存大小。
    示例值：4
    DiskUsage 否 String 系统盘或数据盘。取值范围：
  • SYSTEM_DISK：表示系统盘
  • DATA_DISK：表示数据盘。
    示例值：DATA_DISK
    		•
    CPU 否 Integer 实例CPU核数。
    示例值：2
    DedicatedClusterId 否 String 专用集群ID。
    示例值：cluster-ay3xxxxf

    3. 输出参数

    参数名称 类型 描述
    DiskConfigSet Array of DiskConfig 云盘配置列表。
    RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询上海五区高性能云硬盘的可售卖规格

    查询上海五区高性能云硬盘的可售卖规格

    输入示例

    POST / HTTP/1.1
Host: cbs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDiskConfigQuota
<公共请求参数>

{
    "InquiryType": "INQUIRY_CBS_CONFIG",
    "DiskChargeType": "POSTPAID_BY_HOUR",
    "Zones": [
        "ap-shanghai-5"
    ],
    "DiskTypes": [
        "CLOUD_PREMIUM"
    ]
}

    输出示例

    {
    "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": {
                    "UnitPriceDiscount": 0.21,
                    "UnitPrice": 0.21
                }
            }
        ],
        "RequestId": "50346458-c053-47f1-b60f-5507e7cc5b26"
    }
}

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

    错误码 描述
    InvalidParameterValue 参数取值错误。
    MissingParameter 缺少参数错误。
    UnsupportedOperation 操作不支持。
    中国站