Queries the zones where ApsaraDB for Redis instances can be deployed.

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 Yes DescribeZones

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

RegionId String No cn-hangzhou

The ID of the region.
AcceptLanguage String No en-US

The language used for the returned value. Valid values:

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

Response parameters

Parameter Type Example Description
Zones Array of KVStoreZone

The zones that are returned.
KVStoreZone
Disabled Boolean false

Indicates whether the ApsaraDB for Redis instance can be created in the current zone.
IsRds Boolean true

Indicates whether the zone is managed by Relational Database Service (RDS). The value of this parameter is true for ApsaraDB for Redis.

RegionId String cn-huhehaote

The ID of the region to which the zone belongs.
SwitchNetwork Boolean true

Indicates whether the zone allows you to switch the network type of an ApsaraDB for Redis instance from classic network to virtual private cloud (VPC). Valid values:

  • true: The network type can be changed from classic network to VPC.
  • false: The network type cannot be changed from classic network to VPC.
ZoneId String cn-huhehaote-b

The ID of the zone.
ZoneName String Hohhot Zone B

The name of the zone.
RequestId String 1D42F072-72FE-4DC4-BB8E-64B1D298****

The ID of the request.

Examples

Sample requests

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

Sample success responses

XML format 

<DescribeZonesResponse>
      <RequestId>1D42F072-72FE-4DC4-BB8E-64B1D298****</RequestId>
          <Zones>
            <KVStoreZone>
                  <ZoneName>Hohhot Zone B</ZoneName>
                  <IsRds>true</IsRds>
                  <Disabled>false</Disabled>
                  <RegionId>cn-huhehaote</RegionId>
                  <ZoneId>cn-huhehaote-b</ZoneId>
                  <SwitchNetwork>true</SwitchNetwork>
                </KVStoreZone>
            <KVStoreZone>
                  <ZoneName>Hohhot Zone A</ZoneName>
                  <IsRds>true</IsRds>
                  <Disabled>false</Disabled>
                  <RegionId>cn-huhehaote</RegionId>
                  <ZoneId>cn-huhehaote-a</ZoneId>
                  <SwitchNetwork>true</SwitchNetwork>
            </KVStoreZone>
          </Zones>
</DescribeZonesResponse>

JSON format 

{
    "RequestId": "1D42F072-72FE-4DC4-BB8E-64B1D298****",
    "Zones": {
        "KVStoreZone": [
			{
				"ZoneName": "Hohhot Zone B",
				"IsRds": true,
				"Disabled": false,
				"RegionId": "cn-huhehaote",
				"ZoneId": "cn-huhehaote-b",
				"SwitchNetwork": true
			},
			{
				"ZoneName": "Hohhot Zone A",
				"IsRds": true,
				"Disabled": false,
				"RegionId": "cn-huhehaote",
				"ZoneId": "cn-huhehaote-a",
				"SwitchNetwork": true
			}
        ]
    }
}

Error codes

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