Queries information about the regions and zones of ApsaraDB for ClickHouse.

Request parameters

Parameter Type Required Example Description
Action String No DescribeRegions

The operation that you want to perform. Set the value to DescribeRegions.

Response parameters

Parameter Type Example Description
RequestId String F5178C10-1407-4987-9133-DE4DC9119F75

The ID of the request.

Regions Array of Region

The details about regions.

Region
Zones Array of Zone

The details about zones.

Zone
ZoneId String cn-hangzhou-h

The ID of the zone.

VpcEnabled Boolean true

Indicates whether virtual private clouds (VPCs) are supported. Valid values:

  • true: VPCs are supported.
  • false: VPCs are not supported.
RegionId String cn-hangzhou

The ID of the region.

Examples

Sample requests

http(s)://clickhouse.aliyuncs.com/?Action=DescribeRegions
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeRegionsResponse>
    <RequestId>F5178C10-1407-4987-9133-DE4DC9119F75</RequestId>
    <Regions>
        <Zones>
            <ZoneId>cn-hangzhou-h</ZoneId>
            <VpcEnabled>true</VpcEnabled>
        </Zones>
        <RegionId>cn-hangzhou</RegionId>
    </Regions>
</DescribeRegionsResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "F5178C10-1407-4987-9133-DE4DC9119F75",
  "Regions" : {
    "Zones" : {
      "ZoneId" : "cn-hangzhou-h",
      "VpcEnabled" : true
    },
    "RegionId" : "cn-hangzhou"
  }
}

Error codes

For a list of error codes, visit the API Error Center.