1. 接口描述
接口请求域名: postgres.tencentcloudapi.com 。
本接口 (DescribeRegions) 用于查询售卖地域信息。
默认接口请求频率限制:1000次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeRegions。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 返回的结果数量。 示例值:7 |
RegionSet | Array of RegionInfo | 地域信息集合。 示例值:[ { "Region": "ap-guangzhou", "RegionName": "华南地区(广州)", "RegionId": 1, "SupportInternational": 0, "RegionState": "AVAILABLE" }, { "Region": "ap-chengdu", "RegionName": "西南地区(成都)", "RegionId": 16, "SupportInternational": 0, "RegionState": "AVAILABLE" }, { "Region": "na-siliconvalley", "RegionName": "美国西部(硅谷)", "RegionId": 15, "SupportInternational": 1, "RegionState": "AVAILABLE" } ] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询所有地域
输入示例
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRegions
<公共请求参数>
{}
输出示例
{
"Response": {
"RequestId": "0872c9bb-0540-4ac4-80cf-ba63bd771b0a",
"TotalCount": 7,
"RegionSet": [
{
"Region": "ap-guangzhou",
"RegionName": "华南地区(广州)",
"RegionId": 1,
"SupportInternational": 0,
"RegionState": "AVAILABLE"
},
{
"Region": "ap-chengdu",
"RegionName": "西南地区(成都)",
"RegionId": 16,
"SupportInternational": 0,
"RegionState": "AVAILABLE"
},
{
"Region": "ap-shanghai",
"RegionName": "华东地区(上海)",
"RegionId": 4,
"SupportInternational": 0,
"RegionState": "AVAILABLE"
},
{
"Region": "na-toronto",
"RegionName": "北美地区(多伦多)",
"RegionId": 6,
"SupportInternational": 1,
"RegionState": "UNAVAILABLE"
},
{
"Region": "ap-shanghai-fsi",
"RegionName": "华东地区(上海金融)",
"RegionId": 7,
"SupportInternational": 0,
"RegionState": "AVAILABLE"
},
{
"Region": "ap-beijing",
"RegionName": "华北地区(北京)",
"RegionId": 8,
"SupportInternational": 0,
"RegionState": "AVAILABLE"
},
{
"Region": "na-siliconvalley",
"RegionName": "美国西部(硅谷)",
"RegionId": 15,
"SupportInternational": 1,
"RegionState": "AVAILABLE"
}
]
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure.UnauthorizedOperation | 鉴权失败。 |
FailedOperation.CamSigAndAuthError | 鉴权失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
FailedOperation.DatabaseAccessError | 管控元数据库访问失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
FailedOperation.DatabaseAffectedError | 数据操作失败,请联系客服进行处理。 |
FailedOperation.FailedOperationError | 操作失败,请稍后重试。 |
FailedOperation.WhitelistConnectError | 查询白名单失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
InternalError | 内部错误。 |
InternalError.DBError | 后台DB执行错误。 |
InternalError.InternalHttpServerError | 请求执行异常。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue.InterfaceNameNotFound | ACTION输入错误。 |
InvalidParameterValue.InvalidParameterValueError | 参数值有误。 |
InvalidParameterValue.ParameterHandleError | 参数处理失败,请检参数值设置是否有效。 |
InvalidParameterValue.RegionNotSupported | 不支持当前地域。 |
InvalidParameterValue.StructParseFailed | 解析参数出错。 |
OperationDenied.CamDeniedError | 当前操作被限制。 |
ResourceNotFound.InstanceNotFoundError | 实例不存在。 |
UnsupportedOperation | 操作不支持。 |