All Products
Search
Document Center

Tair (Redis® OSS-Compatible):DescribeRegions

Last Updated:Oct 30, 2024

Queries all regions supported for an ApsaraDB for Redis instance.

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

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****
RegionIdsarray<object>

The region IDs.

KVStoreRegionobject
RegionEndpointstring

The endpoint of the region.

r-kvstore.aliyuncs.com
LocalNamestring

The name of the region.

China (Hangzhou)
RegionIdstring

The ID of the region.

cn-hangzhou
ZoneIdsstring

The IDs of the zones in the region.

cn-hangzhou-h
ZoneIdListarray

The zone IDs.

ZoneIdstring

The ID of the zone.

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.

Change history

Change timeSummary of changesOperation
No change history