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

文档中心

立即注册

导航

TrafficRoute DNS 套件

ListRegions-获取地域列表

最近更新时间：2024.08.23 11:26:47首次发布时间：2023.02.08 13:11:50

获取支持的地域列表。

请求说明

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

请求参数

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

Query

名称	类型	是否必选	示例值	描述
Action	String	是	`ListRegions`	API 的名称。该参数的取值是 `ListRegions`。
Version	String	是	`2022-06-01`	API 的版本。该参数的取值是 `2022-06-01`。
Tag	String	否	`ecs`	服务类型。 ecs：ECS 主机名同步功能支持的地域列表。 resolver：解析器 Resolver 支持的地域列表。如果您不设置该参数，私网解析 PrivateZone 会返回默认的支持地域列表。

返回参数

ResponseMetadata 对象

名称	类型	描述
RequestId	String	标识本次请求的 ID。
Action	String	Action 查询参数的值。
Version	String	API 版本。
Service	String	服务类型。
Region	String	服务所在地域。

Result 对象

名称	类型	描述
Regions	Array of Objects	地域列表。

示例

请求示例

GET https://open.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"
            }
        ]
    }
}

错误码

您可访问公共错误码，获取详细信息。