All Products
Search
Document Center

Tair (Redis® OSS-Compatible):DescribeZones

Last Updated:Dec 19, 2024

Queries the zones available for ApsaraDB for Redis.

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
RegionIdstringNo

The region ID.

cn-huhehaote
AcceptLanguagestringNo

The display language of the response. Default value: zh-CN. Valid values:

  • zh-CN: Chinese
  • en-US: English
en-US

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

The queried zones.

KVStoreZoneobject
IsRdsboolean

Indicates whether the zone is managed by ApsaraDB RDS. The return value of this parameter is true in ApsaraDB for Redis.

true
ZoneIdstring

The ID of the zone within the specified region.

cn-huhehaote-b
Disabledboolean

Indicates whether ApsaraDB for Redis instances can be created in the current zone. Valid values:

  • true: ApsaraDB for Redis instances cannot be created in the current zone.
  • false: ApsaraDB for Redis instances can be created in the current zone.
true
SwitchNetworkboolean

Indicates whether the network type of the instance can be changed from the classic network to Virtual Private Cloud (VPC). Valid values:

  • true: The network type of the instance can be changed from the classic network to VPC.
  • false: The network type of the instance cannot be changed from the classic network to VPC.
true
ZoneNamestring

The name of the zone within the specified region.

Hohhot Zone B
RegionIdstring

The ID of the region.

cn-huhehaote

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
No change history