All Products
Search
Document Center

ApsaraDB for ClickHouse:DescribeRegions

Last Updated:Nov 12, 2024

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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
clickhouse:DescribeRegionsget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

F5178C10-1407-4987-9133-DE4DC9119F75
Regionsarray<object>

The queried regions.

Regionobject
Zonesarray<object>

The zones.

Zoneobject
ZoneIdstring

The zone ID.

cn-hangzhou-h
VpcEnabledboolean

Indicates whether Virtual Private Cloud (VPC) is supported in the zone. Valid values:

  • true
  • false
true
RegionIdstring

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 timeSummary of changesOperation
2024-10-23API Description UpdateView Change Details