1. 接口描述
接口请求域名: bm.tencentcloudapi.com 。
查询地域以及可用区
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeRegions。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-23。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
RegionId | 否 | Integer | 地域整型ID,目前黑石可用地域包括:8-北京,4-上海,1-广州, 19-重庆 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RegionInfoSet | Array of RegionInfo | 地域信息 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询地域以及可用区
输入示例
https://bm.tencentcloudapi.com/?Action=DescribeRegions
&<公共请求参数>
输出示例
{
"Response": {
"RegionInfoSet": [
{
"RegionId": 1,
"RegionDescription": "华南地区(广州)",
"Region": "ap-guangzhou",
"ZoneInfoSet": [
{
"ZoneId": 1000100003,
"ZoneDescription": "广州物理机一区 ",
"Zone": "ap-guangzhou-bls-1"
}
]
},
{
"RegionId": 4,
"RegionDescription": "华东地区(上海)",
"Region": "ap-shanghai",
"ZoneInfoSet": [
{
"ZoneId": 1000400001,
"ZoneDescription": "上海物理机一区",
"Zone": "ap-shanghai-bls-1"
},
{
"ZoneId": 1000400003,
"ZoneDescription": "上海物理机三区",
"Zone": "ap-shanghai-bls-3"
}
]
},
{
"RegionId": 8,
"RegionDescription": "华北地区(北京)",
"Region": "ap-beijing",
"ZoneInfoSet": [
{
"ZoneId": 1000800001,
"ZoneDescription": "北京物理机一区",
"Zone": "ap-beijing-bls-1"
},
{
"ZoneId": 1000800002,
"ZoneDescription": "北京物理机二区",
"Zone": "ap-beijing-bls-2"
},
{
"ZoneId": 1000800003,
"ZoneDescription": "北京物理机三区",
"Zone": "ap-beijing-bls-3"
},
{
"ZoneId": 1000800004,
"ZoneDescription": "北京物理机四区",
"Zone": "ap-beijing-bls-4"
}
]
},
{
"RegionId": 19,
"RegionDescription": "西南地区(重庆)",
"Region": "ap-chongqing",
"ZoneInfoSet": [
{
"ZoneId": 1001900001,
"ZoneDescription": "重庆物理机一区",
"Zone": "ap-chongqing-bls-1"
}
]
}
],
"RequestId": "63caeffd-4782-4704-87d6-c9ce36532c0e"
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。