该接口用于查询可选的 ClickHouse 地域和可用区。

请求参数

名称 类型 是否必须 描述
Action String 系统规定参数,取值:DescribeRegions。

返回参数

名称 类型 描述
<公共返回参数> - 详见公共参数
Regions List<Region> 返回Region列表。

Region参数

参数 类型 描述
RegionId String 地域ID,如cn-hangzhou。
Zones List<Zones> 可用区列表。

Zones参数

参数 类型 描述
ZoneId String 可用区ID,如cn-hangzhou-g。
VpcEnabled String 支持VPC。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeRegions
&<公共请求参数>

正常返回示例

XML 格式

<DescribeRegionsResponse>
  <Regions>
        <Region>
              <RegionId>cn-hangzhou</RegionId>
              <Zones>
                    <Zone>
                          <VpcEnabled>true</VpcEnabled>
                          <ZoneId>cn-hangzhou-i</ZoneId>
                    </Zone>
                    <Zone>
                          <VpcEnabled>true</VpcEnabled>
                          <ZoneId>cn-hangzhou-g</ZoneId>
                    </Zone>
              </Zones>
        </Region>
        <Region>
              <RegionId>cn-shanghai</RegionId>
              <Zones>
                    <Zone>
                          <VpcEnabled>true</VpcEnabled>
                          <ZoneId>cn-shanghai-e</ZoneId>
                    </Zone>
                    <Zone>
                          <VpcEnabled>true</VpcEnabled>
                          <ZoneId>cn-shanghai-f</ZoneId>
                    </Zone>
                    <Zone>
                          <VpcEnabled>true</VpcEnabled>
                          <ZoneId>cn-shanghai-d</ZoneId>
                    </Zone>
              </Zones>
        </Region>
        <Region>
              <RegionId>cn-beijing</RegionId>
              <Zones>
                    <Zone>
                          <VpcEnabled>true</VpcEnabled>
                          <ZoneId>cn-beijing-h</ZoneId>
                    </Zone>
                    <Zone>
                          <VpcEnabled>true</VpcEnabled>
                          <ZoneId>cn-beijing-g</ZoneId>
                    </Zone>
                    <Zone>
                          <VpcEnabled>true</VpcEnabled>
                          <ZoneId>cn-beijing-e</ZoneId>
                    </Zone>
              </Zones>
        </Region>
        <Region>
              <RegionId>cn-shenzhen</RegionId>
              <Zones>
                    <Zone>
                          <VpcEnabled>true</VpcEnabled>
                          <ZoneId>cn-shenzhen-e</ZoneId>
                    </Zone>
              </Zones>
        </Region>
        <Region>
              <RegionId>ap-southeast-1</RegionId>
              <Zones>
                    <Zone>
                          <VpcEnabled>true</VpcEnabled>
                          <ZoneId>ap-southeast-1c</ZoneId>
                    </Zone>
                    <Zone>
                          <VpcEnabled>true</VpcEnabled>
                          <ZoneId>ap-southeast-1a</ZoneId>
                    </Zone>
              </Zones>
        </Region>
  </Regions>
</DescribeRegionsResponse>

JSON 格式

{
    "Regions":{
        "Region":[
            {
                "RegionId":"cn-hangzhou",
                "Zones":{
                    "Zone":[
                        {
                            "VpcEnabled":true,
                            "ZoneId":"cn-hangzhou-i"
                        },
                        {
                            "VpcEnabled":true,
                            "ZoneId":"cn-hangzhou-g"
                        }
                    ]
                }
            },
            {
                "RegionId":"cn-shanghai",
                "Zones":{
                    "Zone":[
                        {
                            "VpcEnabled":true,
                            "ZoneId":"cn-shanghai-e"
                        },
                        {
                            "VpcEnabled":true,
                            "ZoneId":"cn-shanghai-f"
                        },
                        {
                            "VpcEnabled":true,
                            "ZoneId":"cn-shanghai-d"
                        }
                    ]
                }
            },
            {
                "RegionId":"cn-beijing",
                "Zones":{
                    "Zone":[
                        {
                            "VpcEnabled":true,
                            "ZoneId":"cn-beijing-h"
                        },
                        {
                            "VpcEnabled":true,
                            "ZoneId":"cn-beijing-g"
                        },
                        {
                            "VpcEnabled":true,
                            "ZoneId":"cn-beijing-e"
                        }
                    ]
                }
            },
            {
                "RegionId":"cn-shenzhen",
                "Zones":{
                    "Zone":[
                        {
                            "VpcEnabled":true,
                            "ZoneId":"cn-shenzhen-e"
                        }
                    ]
                }
            },
            {
                "RegionId":"ap-southeast-1",
                "Zones":{
                    "Zone":[
                        {
                            "VpcEnabled":true,
                            "ZoneId":"ap-southeast-1c"
                        },
                        {
                            "VpcEnabled":true,
                            "ZoneId":"ap-southeast-1a"
                        }
                    ]
                }
            }
        ]
    }
}