查询云硬盘配额

最近更新时间:2018-10-26 15:10:09

1. 接口描述

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

本接口(DescribeDiskConfigQuota)用于查询云硬盘配额。

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cbs.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

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

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

    3. 输出参数

    参数名称 类型 描述
    DiskConfigSet Array of DiskConfig 云盘配置列表。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询广州三区的云硬盘配置

    输入示例

    https://cbs.tencentcloudapi.com/?Action=DescribeDiskConfigQuota
    &InquiryType=INQUIRY_CBS_CONFIG
    &Zones.0=ap-guangzhou-2
    &<公共请求参数>

    输出示例

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

    示例2 查询广州三区S3机型可搭配的云盘配置

    输入示例

    https://cbs.tencentcloudapi.com/?Action=DescribeDiskConfigQuota
    &InquiryType=INQUIRY_CVM_CONFIG
    &Zones.0=ap-guangzhou-2
    &InstanceFamilies.0=S3
    &<公共请求参数>

    输出示例

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

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。
    MissingParameter 参数缺失。请求没有带必选参数。

    如果有其他疑问,您也可以在问答社区中寻求帮助。前往问答社区 >