All Products
Search
Document Center

Tair:DescribeRegions

Last Updated:Feb 20, 2024

Queries the regions in which ApsaraDB for Redis instances can be created.

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 display language of the LocalName parameter value. Valid values:

  • zh-CN: Chinese
  • en-US: English
Note The default value is zh-CN.
zh-CN

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

AD425AD3-CC7B-4EE2-A5CB-2F61BA73****
RegionIdsobject []

The value of the RegionIds parameter is in the array format. Each element in the array contains the RegionId and ZoneIds parameters.

RegionEndpointstring

The endpoint of the region.

r-kvstore.aliyuncs.com
LocalNamestring

The name of the region.

China (Hangzhou)
RegionIdstring

The region ID of the instance.

cn-hangzhou
ZoneIdsstring

The zone ID of the instance.

cn-hangzhou-h
ZoneIdListarray

The list of zone IDs.

string

The zone ID of the instance.

cn-hangzhou-h

Examples

Sample success responses

JSONformat

{
  "RequestId": "AD425AD3-CC7B-4EE2-A5CB-2F61BA73****",
  "RegionIds": {
    "KVStoreRegion": [
      {
        "RegionEndpoint": "r-kvstore.aliyuncs.com",
        "LocalName": "China (Hangzhou)\n",
        "RegionId": "cn-hangzhou",
        "ZoneIds": "cn-hangzhou-h",
        "ZoneIdList": {
          "ZoneId": [
            "cn-hangzhou-h"
          ]
        }
      }
    ]
  }
}

Error codes

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