1. 接口描述
接口请求域名: cbs.api3.fincloud.tencent.cn。
本接口(DescribeDiskConfigQuota)用于查询云硬盘配额。
默认接口请求频率限制:20次/秒。
接口更新时间:2024-08-09 13:00:09。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeDiskConfigQuota |
| Version | 是 | 否 | String | 公共参数,本接口取值:2017-03-12 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InquiryType | 是 | 否 | String | 查询类别,取值范围。 示例值: INQUIRY_CVM_CONFIG |
| Zones | 否 | 否 | Array of String | 查询一个或多个可用区下的配置。 示例值: ["ap-region1-7"] |
| DiskChargeType | 否 | 否 | String | 付费模式。取值范围: 示例值: POSTPAID_BY_HOUR |
| DiskTypes | 否 | 否 | Array of String | 硬盘介质类型。取值范围: 示例值: ["CLOUD_PREMIUM"] |
| DiskUsage | 否 | 否 | String | 系统盘或数据盘。取值范围: 示例值: DATA_DISK |
| DeviceClasses | 否 | 否 | Array of String | 实例机型。 示例值: ["VSELF_5"] |
| InstanceFamilies | 否 | 否 | Array of String | 按照实例机型系列过滤。实例机型系列形如:S1、I1、M1等。详见 实例类型 示例值: ["S3"] |
| CPU | 否 | 否 | Uint64 | 实例CPU核数。 示例值: 2 |
| Memory | 否 | 否 | Uint64 | 实例内存大小。 示例值: 4 |
| InnerInquiryType | 否 | 否 | String | INQUIRY_RESIZE、INQUIRY_CREATE 示例值: INQUIRY_CBS_CONFIG |
| DedicatedClusterId | 否 | 否 | String | 本地专用集群ID。 示例值: cluster-ay3cdplf |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DiskConfigSet | Array of DiskConfig | 云盘配置列表。 示例值:查看 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue | 无效参数值。参数值格式错误或者参数值不被支持等。 |
| MissingParameter | 参数缺失。请求没有带必选参数。 |
| InternalError.ComponentError | 第三方组件错误 |
5. 示例
示例1 查询region1三区的云硬盘配置
输入示例
https://cbs.api3.fincloud.tencent.cn/?Action=DescribeDiskConfigQuota
&InquiryType=INQUIRY_CBS_CONFIG
&Zones.0=ap-region1-3
&<公共请求参数>
输出示例
{
"Response": {
"DiskConfigSet": [
{
"Available": true,
"DiskChargeType": "PREPAID",
"Zone": "ap-region1-3",
"DiskType": "CLOUD_PREMIUM",
"DiskUsage": "DATA_DISK",
"MinDiskSize": 50,
"MaxDiskSize": 4000
},
{
"Available": false,
"DiskChargeType": "PREPAID",
"Zone": "ap-region1-3",
"DiskType": "CLOUD_BASIC",
"DiskUsage": "DATA_DISK",
"MinDiskSize": 10,
"MaxDiskSize": 16000
},
{
"Available": true,
"DiskChargeType": "PREPAID",
"Zone": "ap-region1-3",
"DiskType": "CLOUD_SSD",
"DiskUsage": "DATA_DISK",
"MinDiskSize": 100,
"MaxDiskSize": 4000
}
],
"RequestId": "55db49cf-b9d7-da27-825b-5a02ba6884ca"
}
}