All Products
Search
Document Center

ApsaraDB RDS:DescribeRegions

Last Updated:Apr 28, 2024

Queries the details of the regions that are available for ApsaraDB RDS.

Operation description

Before you call the CreateDBInstance operation to create an RDS instance, you can call the DescribeRegions operation to query the available regions and zones.

Note If a zone supports the multi-zone deployment method, the value of the ZoneId parameter for the zone contains an MAZ part. Examples: cn-hangzhou-MAZ6(b,f) and cn-hangzhou-MAZ5(b,e,f).

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
AcceptLanguagestringNo

The language that is used for the return value of the LocalName parameter. Valid values:

  • zh-CN: Chinese
  • en-US: English

Default value: en-US.

en-US

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

1AD222E9-E606-4A42-BF6D-8A4442913CEF
Regionsobject []

An array that consists of the available regions and zones.

ZoneIdstring

The ID of the zone.

cn-hangzhou-h
RegionEndpointstring

The endpoint that is used to connect to Alibaba Cloud services in the region. For more information, see Request structure.

rds.aliyuncs.com
LocalNamestring

The name of the region. The return value of the LocalName parameter is in the language that is specified by the AcceptLanguage parameter. For example, if the value of the RegionId parameter in the response is cn-hangzhou, the following values are returned for the LocalName parameter:

  • If the value of the AcceptLanguage parameter is zh-CN, the value China (Hangzhou) is returned for the LocalName parameter.
  • If the value of the AcceptLanguage parameter is en-US, the value China (Hangzhou) is returned for the LocalName parameter.
China (Hangzhou)
RegionIdstring

The ID of the region.

cn-hangzhou
ZoneNamestring

The name of the zone. The return value of the ZoneName parameter is in the language that is specified by the AcceptLanguage parameter. For example, if the value of the RegionId parameter in the response is cn-hangzhou-h, the following values are returned for the LocalName parameter:

  • If the value of the AcceptLanguage parameter is zh-CN, the value Hangzhou Zone H is returned for the LocalName parameter.
  • If the value of the AcceptLanguage parameter is en-US, the value Hangzhou Zone H is returned for the LocalName parameter.
Hangzhou Zone H

Examples

Sample success responses

JSONformat

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Regions": {
    "RDSRegion": [
      {
        "ZoneId": "cn-hangzhou-h",
        "RegionEndpoint": "rds.aliyuncs.com",
        "LocalName": "China (Hangzhou)",
        "RegionId": "cn-hangzhou",
        "ZoneName": "Hangzhou Zone H"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError message
404InvalidAcceptLanguage.NotFoundOnly Chinese (zh-CN) and English (en-US) are allowed.

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

Change history

Change timeSummary of changesOperation
No change history