查询产品支持的地域列表

最近更新时间：2024-04-22 01:23:35

我的收藏

本页目录：

1. 接口描述

接口请求域名： region.tencentcloudapi.com 。

本接口(DescribeRegions)用于查询各个产品支持地域信息。

默认接口请求频率限制：50次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeRegions。
Version	是	String	公共参数，本接口取值：2022-06-27。
Region	否	String	公共参数，此参数为可选参数。
Product	是	String	待查询产品的名称，例如cvm，具体取值请查询DescribeProducts接口示例值：cvm
Scene	否	Integer	不传或者0表示不查询【可选业务白名单】，1表示查询【可选业务白名单】，该参数设置了1，只有在业务白名单查不到情况下，才会查该白名单示例值：1

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	地域数量示例值：1
RegionSet	Array of RegionInfo	地域列表信息示例值：参考输出示例
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询产品支持的地域列表

查询产品支持的地域列表

输入示例

POST / HTTP/1.1
Host: region.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRegions
<公共请求参数>

{
    "Product": "cvm",
    "Scene": 1
}

输出示例

{
    "Response": {
        "TotalCount": 21,
        "RequestId": "2b41c59d-93c8-43e2-a2f0-6c5df9735d21",
        "RegionSet": [
            {
                "RegionIdMC": null,
                "LocationMC": null,
                "RegionState": "AVAILABLE",
                "RegionNameMC": null,
                "Region": "ap-guangzhou",
                "RegionTypeMC": null,
                "RegionName": "华南地区(广州)"
            },
            {
                "RegionIdMC": null,
                "LocationMC": null,
                "RegionState": "AVAILABLE",
                "RegionNameMC": null,
                "Region": "ap-shanghai",
                "RegionTypeMC": null,
                "RegionName": "华东地区(上海)"
            },
            {
                "RegionIdMC": null,
                "LocationMC": null,
                "RegionState": "AVAILABLE",
                "RegionNameMC": null,
                "Region": "ap-nanjing",
                "RegionTypeMC": null,
                "RegionName": "华东地区(南京)"
            },
            {
                "RegionIdMC": null,
                "LocationMC": null,
                "RegionState": "AVAILABLE",
                "RegionNameMC": null,
                "Region": "ap-beijing",
                "RegionTypeMC": null,
                "RegionName": "华北地区(北京)"
            },
            {
                "RegionIdMC": null,
                "LocationMC": null,
                "RegionState": "AVAILABLE",
                "RegionNameMC": null,
                "Region": "ap-chengdu",
                "RegionTypeMC": null,
                "RegionName": "西南地区(成都)"
            },
            {
                "RegionIdMC": null,
                "LocationMC": null,
                "RegionState": "AVAILABLE",
                "RegionNameMC": null,
                "Region": "ap-chongqing",
                "RegionTypeMC": null,
                "RegionName": "西南地区(重庆)"
            },
            {
                "RegionIdMC": null,
                "LocationMC": null,
                "RegionState": "AVAILABLE",
                "RegionNameMC": null,
                "Region": "ap-xian-ec",
                "RegionTypeMC": null,
                "RegionName": "西北地区(西安)"
            },
            {
                "RegionIdMC": null,
                "LocationMC": null,
                "RegionState": "AVAILABLE",
                "RegionNameMC": null,
                "Region": "ap-hongkong",
                "RegionTypeMC": null,
                "RegionName": "港澳台地区(中国香港)"
            },
            {
                "RegionIdMC": null,
                "LocationMC": null,
                "RegionState": "AVAILABLE",
                "RegionNameMC": null,
                "Region": "ap-guiyang",
                "RegionTypeMC": null,
                "RegionName": "西南地区(贵阳)"
            },
            {
                "RegionIdMC": null,
                "LocationMC": null,
                "RegionState": "AVAILABLE",
                "RegionNameMC": null,
                "Region": "ap-seoul",
                "RegionTypeMC": null,
                "RegionName": "亚太东北(首尔)"
            },
            {
                "RegionIdMC": null,
                "LocationMC": null,
                "RegionState": "AVAILABLE",
                "RegionNameMC": null,
                "Region": "ap-tokyo",
                "RegionTypeMC": null,
                "RegionName": "亚太东北(东京)"
            },
            {
                "RegionIdMC": null,
                "LocationMC": null,
                "RegionState": "AVAILABLE",
                "RegionNameMC": null,
                "Region": "ap-singapore",
                "RegionTypeMC": null,
                "RegionName": "亚太东南(新加坡)"
            },
            {
                "RegionIdMC": null,
                "LocationMC": null,
                "RegionState": "AVAILABLE",
                "RegionNameMC": null,
                "Region": "ap-bangkok",
                "RegionTypeMC": null,
                "RegionName": "亚太东南(曼谷)"
            },
            {
                "RegionIdMC": null,
                "LocationMC": null,
                "RegionState": "AVAILABLE",
                "RegionNameMC": null,
                "Region": "ap-jakarta",
                "RegionTypeMC": null,
                "RegionName": "亚太东南(雅加达)"
            },
            {
                "RegionIdMC": null,
                "LocationMC": null,
                "RegionState": "AVAILABLE",
                "RegionNameMC": null,
                "Region": "na-siliconvalley",
                "RegionTypeMC": null,
                "RegionName": "美国西部(硅谷)"
            },
            {
                "RegionIdMC": null,
                "LocationMC": null,
                "RegionState": "AVAILABLE",
                "RegionNameMC": null,
                "Region": "eu-frankfurt",
                "RegionTypeMC": null,
                "RegionName": "欧洲地区(法兰克福)"
            },
            {
                "RegionIdMC": null,
                "LocationMC": null,
                "RegionState": "AVAILABLE",
                "RegionNameMC": null,
                "Region": "ap-mumbai",
                "RegionTypeMC": null,
                "RegionName": "亚太南部(孟买)"
            },
            {
                "RegionIdMC": null,
                "LocationMC": null,
                "RegionState": "AVAILABLE",
                "RegionNameMC": null,
                "Region": "na-ashburn",
                "RegionTypeMC": null,
                "RegionName": "美国东部(弗吉尼亚)"
            },
            {
                "RegionIdMC": null,
                "LocationMC": null,
                "RegionState": "AVAILABLE",
                "RegionNameMC": null,
                "Region": "sa-saopaulo",
                "RegionTypeMC": null,
                "RegionName": "南美地区(圣保罗)"
            },
            {
                "RegionIdMC": null,
                "LocationMC": null,
                "RegionState": "AVAILABLE",
                "RegionNameMC": null,
                "Region": "na-toronto",
                "RegionTypeMC": null,
                "RegionName": "北美地区(多伦多)"
            }
        ]
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameter	参数错误。
InvalidParameter.ParameterError	参数错误。
RequestLimitExceeded	请求的次数超过了频率限制。

上一篇: 查询支持地域列表查询的产品下一篇: 查询产品可用区列表