ListRegions - -获取地域列表--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

ListRegions - -获取地域列表

最近更新时间：2025.05.22 19:59:36首次发布时间：2023.02.08 13:11:50

获取支持的地域列表。

使用说明

请求频率：每秒最多调用 100 次。

请求说明

请求方式：GET
请求地址：https://private-zone.volcengineapi.com/?Action=ListRegions?Version=2022-06-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

除了以下参数，您还需要对请求进行鉴权。

参数	类型	是否必填	示例值	描述
Action	String	是	ListRegions	要执行的操作，取值：ListRegions。
Version	String	是	2022-06-01	API的版本，取值：2022-06-01。
ProjectName	String	否	example	项目名称。如果您不传入该参数，该参数不作为查询条件。
Tag	String	否	ecs	服务类型。 ecs：ECS 主机名同步功能支持的地域列表。 resolver：解析器 Resolver 支持的地域列表。如果您不设置该参数，私网解析 PrivateZone 会返回默认的支持地域列表。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Regions	Array of Object	无	地域列表。

请求示例

GET https://private-zone.volcengineapi.com/?Action=ListRegions&Version=2022-06-01

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20221213175116010210067141249D15EB",
        "Action": "ListRegions",
        "Version": "2022-06-01",
        "Service": "private_zone",
        "Region": "cn"
    },
    "Result": {
        "Regions": [
            {
                "Name": "华北2（北京）",
                "Code": "cn-beijing"
            },
            {
                "Name": "华东2（上海）",
                "Code": "cn-shanghai"
            },
            {
                "Name": "华南1（广州）",
                "Code": "cn-guangzhou"
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
500	ErrInternalServer	server internal error	服务内部错误