DescribeRegions - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example

The current API does not require request parameters

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	F5178C10-1407-4987-9133-DE4DC9119F75
Regions	array<object>	The queried regions.
Region	object
Zones	array<object>	The zones.
Zone	object
ZoneId	string	The zone ID.	cn-hangzhou-h
VpcEnabled	boolean	Indicates whether Virtual Private Cloud (VPC) is supported in the zone. Valid values: true false	true
RegionId	string	The region ID.	cn-hangzhou

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-10-23	API Description Update	View Change Details