1. 接口描述
接口请求域名: cvm.tencentcloudapi.com 。
本接口(DescribeZones)用于查询可用区信息。
默认接口请求频率限制:20次/秒。
注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cvm.ap-shanghai-fsi.tencentcloudapi.com。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeZones。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 可用区数量。 |
ZoneSet | Array of ZoneInfo | 可用区列表信息。 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询可用区信息(可用区中文名称)
查询广州地域的可用区信息。返回可用区的中文名称需要传参Language=zh-CN。
输入示例
GET POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeZones
X-TC-Language: zh-CN
<公共请求参数>
{}
输出示例
{
"Response": {
"TotalCount": 5,
"ZoneSet": [
{
"ZoneState": "UNAVAILABLE",
"ZoneId": "100001",
"Zone": "ap-guangzhou-1",
"ZoneName": "广州一区"
},
{
"ZoneState": "AVAILABLE",
"ZoneId": "100002",
"Zone": "ap-guangzhou-2",
"ZoneName": "广州二区"
},
{
"ZoneState": "AVAILABLE",
"ZoneId": "100003",
"Zone": "ap-guangzhou-3",
"ZoneName": "广州三区"
},
{
"ZoneState": "AVAILABLE",
"ZoneId": "100004",
"Zone": "ap-guangzhou-4",
"ZoneName": "广州四区"
},
{
"ZoneState": "AVAILABLE",
"ZoneId": "100005",
"Zone": "ap-guangzhou-5",
"ZoneName": "广州五区"
}
],
"RequestId": "62DDFFC6-FDB5-44F7-20A6-59152E3D129A"
}
}
示例2 查询可用区信息(可用区英文名称)
查询广州地域的可用区信息。不传Language参数默认返回可用区的英文名称。
输入示例
GET https://cvm.tencentcloudapi.com/?Action=DescribeZones
&<公共请求参数>
输出示例
{
"Response": {
"TotalCount": 5,
"ZoneSet": [
{
"ZoneState": "UNAVAILABLE",
"ZoneId": "100001",
"Zone": "ap-guangzhou-1",
"ZoneName": "Guangzhou Zone 1"
},
{
"ZoneState": "AVAILABLE",
"ZoneId": "100002",
"Zone": "ap-guangzhou-2",
"ZoneName": "Guangzhou Zone 2"
},
{
"ZoneState": "AVAILABLE",
"ZoneId": "100003",
"Zone": "ap-guangzhou-3",
"ZoneName": "Guangzhou Zone 3"
},
{
"ZoneState": "AVAILABLE",
"ZoneId": "100004",
"Zone": "ap-guangzhou-4",
"ZoneName": "Guangzhou Zone 4"
},
{
"ZoneState": "AVAILABLE",
"ZoneId": "100005",
"Zone": "ap-guangzhou-5",
"ZoneName": "Guangzhou Zone 5"
}
],
"RequestId": "62DDFFC6-FDB5-44F7-20A6-59152E3D129A"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
- Tencent Cloud CLI 3.0
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。