1. 接口描述
接口请求域名： region.tencentcloudapi.com 。
本接口(DescribeZones)用于查询产品可用区信息。
默认接口请求频率限制：50次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeZones。 |
| Version | 是 | String | 公共参数，本接口取值：2022-06-27。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Product | 是 | String | 待查询产品的名称，例如cvm，具体取值请查询DescribeProducts接口 示例值：cvm |
| Scene | 否 | Integer | 不传或者0表示不查询【可选业务白名单】，1表示查询【可选业务白名单】，该参数设置了1，只有在业务白名单查不到情况下，才会查该白名单 示例值：1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 可用区数量。 示例值：1 |
| ZoneSet | Array of ZoneInfo | 可用区列表信息。 示例值：参开输出示例 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询可用区信息（可用区中文名称）
查询可用区信息（可用区中文名称）
输入示例
POST / HTTP/1.1
Host: region.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeZones
X-TC-Language: zh-CN
<公共请求参数>
{
"Product": "cvm",
"Scene": 1
}输出示例
{
"Response": {
"TotalCount": 7,
"RequestId": "6c3323bd-c855-49d7-85fb-7d6e0d8e1c55",
"ZoneSet": [
{
"Zone": "ap-beijing-2",
"ZoneIdMC": null,
"ZoneId": "800002",
"ParentZoneName": "",
"ParentZoneId": "",
"ParentZone": "",
"ZoneState": "AVAILABLE",
"MachineRoomTypeMC": null,
"ZoneType": "availability-zone",
"ZoneName": "北京二区"
},
{
"Zone": "ap-beijing-3",
"ZoneIdMC": null,
"ZoneId": "800003",
"ParentZoneName": "",
"ParentZoneId": "",
"ParentZone": "",
"ZoneState": "AVAILABLE",
"MachineRoomTypeMC": null,
"ZoneType": "availability-zone",
"ZoneName": "北京三区"
},
{
"Zone": "ap-beijing-4",
"ZoneIdMC": null,
"ZoneId": "800004",
"ParentZoneName": "",
"ParentZoneId": "",
"ParentZone": "",
"ZoneState": "AVAILABLE",
"MachineRoomTypeMC": null,
"ZoneType": "availability-zone",
"ZoneName": "北京四区"
},
{
"Zone": "ap-beijing-5",
"ZoneIdMC": null,
"ZoneId": "800005",
"ParentZoneName": "",
"ParentZoneId": "",
"ParentZone": "",
"ZoneState": "AVAILABLE",
"MachineRoomTypeMC": null,
"ZoneType": "availability-zone",
"ZoneName": "北京五区"
},
{
"Zone": "ap-beijing-6",
"ZoneIdMC": null,
"ZoneId": "800006",
"ParentZoneName": "",
"ParentZoneId": "",
"ParentZone": "",
"ZoneState": "AVAILABLE",
"MachineRoomTypeMC": null,
"ZoneType": "availability-zone",
"ZoneName": "北京六区"
},
{
"Zone": "ap-beijing-7",
"ZoneIdMC": null,
"ZoneId": "800007",
"ParentZoneName": "",
"ParentZoneId": "",
"ParentZone": "",
"ZoneState": "AVAILABLE",
"MachineRoomTypeMC": null,
"ZoneType": "availability-zone",
"ZoneName": "北京七区"
},
{
"Zone": "ap-beijing-tez-changchun-1",
"ZoneIdMC": null,
"ZoneId": "2100080001",
"ParentZoneName": "北京三区",
"ParentZoneId": "800003",
"ParentZone": "ap-beijing-3",
"ZoneState": "AVAILABLE",
"MachineRoomTypeMC": null,
"ZoneType": "edge-zone",
"ZoneName": "长春边缘一区"
}
]
}
}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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| InvalidParameter.ParameterError | 参数错误。 |
| UnsupportedOperation | 操作不支持。 |
