1. 接口描述
接口请求域名: cvm.tencentcloudapi.com 。
本接口(DescribeRegions)用于查询地域信息。因平台策略原因,该接口暂时停止更新,为确保您正常调用,可切换至新链接:https://cloud.tencent.com/document/product/1596/77930。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeRegions。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 地域数量。 示例值:9 |
RegionSet | Array of RegionInfo | 地域列表信息。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求例子
输入示例
POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRegions
<公共请求参数>
{}
输出示例
{
"Response": {
"TotalCount": 9,
"RegionSet": [
{
"Region": "ap-beijing",
"RegionName": "华北地区(北京)",
"RegionState": "AVAILABLE"
},
{
"Region": "ap-guangzhou",
"RegionName": "华南地区(广州)",
"RegionState": "AVAILABLE"
},
{
"Region": "ap-hongkong",
"RegionName": "港澳台地区(中国香港)",
"RegionState": "AVAILABLE"
},
{
"Region": "ap-shanghai",
"RegionName": "华东地区(上海)",
"RegionState": "AVAILABLE"
},
{
"Region": "ap-shanghai-fsi",
"RegionName": "华东地区(上海金融)",
"RegionState": "AVAILABLE"
},
{
"Region": "ap-shenzhen-fsi",
"RegionName": "华南地区(深圳金融)",
"RegionState": "AVAILABLE"
},
{
"Region": "ap-singapore",
"RegionName": "亚太东南(新加坡)",
"RegionState": "AVAILABLE"
},
{
"Region": "na-siliconvalley",
"RegionName": "美国西部(硅谷)",
"RegionState": "AVAILABLE"
}
],
"RequestId": "C563943B-3BEA-FE92-29FE-591EAEB7871F"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
UnsupportedOperation | 操作不支持。 |