All Products
Search
Document Center

Tair:DescribeZones

Last Updated:Mar 20, 2023

Queries the zones available for ApsaraDB for Redis.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The ID of the region.

cn-hangzhou
AcceptLanguagestringNo

The language used for the returned value. Valid values:

  • zh-CN: Chinese.
  • en-US: English.
NoteDefault value: zh-CN.
en-US

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

1D42F072-72FE-4DC4-BB8E-64B1D298****
Zonesarray

The zones that are returned.

object
IsRdsboolean

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

true
ZoneIdstring

The ID of the zone.

cn-huhehaote-b
Disabledboolean

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

false
SwitchNetworkboolean

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.
true
ZoneNamestring

The name of the zone.

RegionIdstring

The ID of the region to which the zone belongs.

cn-huhehaote

Examples

Sample success responses

JSONformat

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

Error codes

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