You can call DescribeRegions to query the regions where 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String No DescribeRegions

The operation that you want to perform. Set this parameter to DescribeRegions.

AcceptLanguage String No zh-CN

The language used for the value to return. Valid values:

  • zh-CN: Chinese.
  • en-US: English.
  • ja: Japanese.
Note Default value: zh-CN.

Response parameters

Prameter Type Sample response Description
RequestId String AD425AD3-CC7B-4EE2-A5CB-2F61BA73011E

The ID of the request.

RegionIds Array

The list in which each element contains RegionId and ZoneIds. The value of the ZoneIds parameter is a string in which multiple ZoneIds are separated by a comma (,).

RegionId String cn-hangzhou

The ID of the region.

ZoneIds String cn-hangzhou-h

The ID of the zone.

LocalName String China (Hangzhou)

The name of the region.

RegionEndpoint String r-kvstore.aliyuncs.com

The endpoint of the region.

ZoneIdList List "ZoneId": ["cn-hangzhou-h","cn-hangzhou-MAZ10(h,i)","cn-hangzhou-MAZ9(g,h)","cn-hangzhou-b","cn-hangzhou-d","cn-hangzhou-e","cn-hangzhou-MAZ6(b,f)","cn-hangzhou-f","cn-hangzhou-g"]

The IDs of zones in the region.

Examples

Sample requests

https://r-kvstore.aliyuncs.com
?Action=DescribeRegions
&<Common request parameter>

Sample success response

XML format

<DescribeRegionsResponse> 
      <RegionIds> 
            <KVStoreRegion> 
              <RegionId>cn-hangzhou</RegionId>  
              <ZoneIdList> 
                    <ZoneId>cn-hangzhou-h</ZoneId>  
                    <ZoneId>cn-hangzhou-MAZ10(h,i)</ZoneId>  
                    <ZoneId>cn-hangzhou-MAZ9(g,h)</ZoneId>  
                    <ZoneId>cn-hangzhou-b</ZoneId>  
                    <ZoneId>cn-hangzhou-d</ZoneId>  
                    <ZoneId>cn-hangzhou-e</ZoneId>  
                    <ZoneId>cn-hangzhou-MAZ6(b,f)</ZoneId>  
                    <ZoneId>cn-hangzhou-f</ZoneId>  
                    <ZoneId>cn-hangzhou-g</ZoneId> 
              </ZoneIdList>  
              <RegionEndpoint>r-kvstore.aliyuncs.com</RegionEndpoint>  
              <ZoneIds>cn-hangzhou-h,cn-hangzhou-MAZ10(h,i),cn-hangzhou-MAZ9(g,h),cn-hangzhou-b,cn-hangzhou-d,cn-hangzhou-e,cn-hangzhou-MAZ6(b,f),cn-hangzhou-f,cn-hangzhou-g</ZoneIds>  
              <LocalName>China (Hangzhou)</LocalName> 
            </KVStoreRegion> 
      </RegionIds>  
      <RequestId>AD425AD3-CC7B-4EE2-A5CB-2F61BA73011E</RequestId> 
</DescribeRegionsResponse>

JSON format

{
    "RegionIds": {
        "KVStoreRegion": [{
                "RegionId": "cn-hangzhou",
                "ZoneIdList": {
                    "ZoneId": [
                        "cn-hangzhou-h",
                        "cn-hangzhou-MAZ10(h,i)",
                        "cn-hangzhou-MAZ9(g,h)",
                        "cn-hangzhou-b",
                        "cn-hangzhou-d",
                        "cn-hangzhou-e",
                        "cn-hangzhou-MAZ6(b,f)",
                        "cn-hangzhou-f",
                        "cn-hangzhou-g"
                    ]
                },
                "RegionEndpoint": "r-kvstore.aliyuncs.com",
                "ZoneIds": "cn-hangzhou-h,cn-hangzhou-MAZ10(h,i),cn-hangzhou-MAZ9(g,h),cn-hangzhou-b,cn-hangzhou-d,cn-hangzhou-e,cn-hangzhou-MAZ6(b,f),cn-hangzhou-f,cn-hangzhou-g",
                "LocalName": "China (Hangzhou)"
            }
        ]
    },
    "RequestId": "AD425AD3-CC7B-4EE2-A5CB-2F61BA73011E"
}

Error codes.

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