说明:当前页面接口为旧版 API,未来可能停止维护,目前不展示在左侧导航。云服务器 API 3.0 版本接口定义更加规范,访问时延下降显著,建议使用 云服务器 API 3.0。
1. 接口描述
本接口 (DescribeZoneAbility) 用于查询可用区的能力,包括 云硬盘 和 私有网络 两种能力查询。
接口请求域名:cvm.api.qcloud.com
2. 输入参数
以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数 页面。
参数名称 | 是否必选 | 类型 | 描述 |
---|---|---|---|
zoneId | 是 | Int | 可用区 ID。 |
capacity.n | 是 | String | 要查询的能力;目前支持云硬盘和私有网络两种能力查询(此接口支持同时传入多个 ID。此参数的具体格式可参考 API 简介 的id.n 一节)。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 公共错误码。0表示成功,其他值表示失败。详见错误码页面的 公共错误码。 |
message | String | 模块错误信息描述,与接口相关。 |
capacitySet | Array | 返回能力信息列表。 |
其中 capacitySet 是一个能力信息的集合,单个能力信息数据结构如下:
参数名称 | 类型 | 描述 |
---|---|---|
capacity | Array | 能力项。 |
isSupported | Int | 是否满足;0为不满足,1为满足。 |
4. 示例
输入
https://cvm.api.qcloud.com/v2/index.php?Action=DescribeZoneAbility &zoneId=800001 &capacity.1=cbs &<公共请求参数>
输出
{
"code" : 0,
"message" : "",
"capacitySet" : [
{
"isSupported" : 1,
"capacity" : [
"cbs"
]
}
]
}