Queries available regions.

Debugging

Alibaba Cloud provides OpenAPI Explorer to simplify API usage. OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeRegions

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

Response parameters

Parameter Type Example Description
Code Integer 200

The HTTP code that is returned.

Message String success

The message that is returned.

RequestId String C458B1E8-1683-3645-B154-6BA32080EEA

The ID of the request.

Success Boolean true

Indicates whether the request is successful.

ErrorCode Integer 200

The HTTP code that is returned.

Regions Array of Region

The list of regions.

Region
SupportPolarx10 Boolean true

Indicates whether PolarDB-X V1.0 is supported in the region.

SupportPolarx20 Boolean true

Indicates whether PolarDB-X V2.0 is supported in the region.

RegionId String ch-hangzhou

The ID of the region.

Zones Array of Zone

The list of zones in the region.

Zone
ZoneId String cn-hangzhou-a

The ID of the zone.

VpcEnabled Boolean true

Indicates whether virtual private clouds (VPCs) are supported in the zone.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeRegions
&<Common request parameters>

Sample success responses

XML format 

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

<DescribeRegionsResponse>
    <Code>200</Code>
    <Message>success</Message>
    <RequestId>C458B1E8-1683-3645-B154-6BA32080EEA</RequestId>
    <Success>true</Success>
    <ErrorCode>200</ErrorCode>
    <Regions>
        <SupportPolarx10>true</SupportPolarx10>
        <SupportPolarx20>true</SupportPolarx20>
        <RegionId>ch-hangzhou</RegionId>
        <Zones>
            <ZoneId>cn-hangzhou-a</ZoneId>
            <VpcEnabled>true</VpcEnabled>
        </Zones>
    </Regions>
</DescribeRegionsResponse>

JSON format 

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

{
  "Code" : 200,
  "Message" : "success",
  "RequestId" : "C458B1E8-1683-3645-B154-6BA32080EEA",
  "Success" : true,
  "ErrorCode" : 200,
  "Regions" : [ {
    "SupportPolarx10" : true,
    "SupportPolarx20" : true,
    "RegionId" : "ch-hangzhou",
    "Zones" : [ {
      "ZoneId" : "cn-hangzhou-a",
      "VpcEnabled" : true
    } ]
  } ]
}

Error codes

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