DescribeZones

Last updated: 2025-11-13 20:51:11

DescribeZones

Last updated: 2025-11-13 20:51:11

1. API Description

Domain name for API request: cynosdb.intl.tencentcloudapi.com.

This API is used to query marketable regional availability zone information.

A maximum of 1000 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: DescribeZones.
Version	Yes	String	Common Params. The value used for this API: 2019-01-07.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
IncludeVirtualZones	No	Boolean	Whether the virtual zone is included.
ShowPermission	No	Boolean	Whether to display all AZs in a region and the user's permissions in each AZ.

3. Output Parameters

Parameter Name	Type	Description
RegionSet	Array of SaleRegion	Region information
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Query Marketable Regional Availability Zone Information

This example shows you how to view only the availability zones that the user has the permission to access.

Input Example

POST / HTTP/1.1
Host: cynosdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeZones
<Common request parameters>

{}

Output Example

{
    "Response": {
        "RegionSet": [
            {
                "DbType": "MYSQL",
                "Region": "ap-guangzhou",
                "RegionId": 100001,
                "Modules": [
                    {
                        "ModuleName": "is.disable.wan",
                        "IsDisable": "yes"
                    }
                ],
"RegionZh": "Guangzhou"
                "ZoneSet": [
                    {
                        "PhysicalZone": "ap-guangzhou-3",
                        "Zone": "ap-guangzhou-3",
                        "IsSupportServerless": 0,
                        "ZoneId": 100003,
                        "IsSupportNormal": 0,
"ZoneZh": "Guangzhou Zone 3"
                        "HasPermission": true,
                        "IsWholeRdmaZone": "tcp",
                        "IsSupportCreateCluster": 1
                    },
                    {
                        "PhysicalZone": "ao-guangzhou-5",
                        "Zone": "ap-guangzhou-5",
                        "IsSupportServerless": 0,
                        "ZoneId": 100004,
                        "IsSupportNormal": 0,
"ZoneZh": "Guangzhou Zone 5"
                        "HasPermission": true,
                        "IsWholeRdmaZone": "whole_rdma",
                        "IsSupportCreateCluster": 0
                    }
                ]
            },
            {
                "DbType": "MYSQL",
                "Region": "ap-beijing",
                "RegionId": 8,
                "Modules": [
                    {
                        "ModuleName": "is.disable.wan",
                        "IsDisable": "no"
                    }
                ],
"RegionZh": "Beijing"
                "ZoneSet": [
                    {
                        "PhysicalZone": "ap-beijing-5",
                        "Zone": "ap-beijing-5",
                        "IsSupportServerless": 0,
                        "ZoneId": 800001,
                        "IsSupportNormal": 0,
"ZoneZh": "Beijing Zone 5"
                        "HasPermission": true,
                        "IsWholeRdmaZone": "whole_rdma",
                        "IsSupportCreateCluster": 1
                    }
                ]
            }
        ],
        "RequestId": "8fa5cf5-77db-4e32-90ef-22c71ed95f51"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation.DatabaseAccessError	Failed to access the database. Please try again later. If the problem persists, please contact customer service.
InternalError.DbOperationFailed	Failed to query the database.
InternalError.InternalHttpServerError	An exception occurred while executing the HTTP request.
UnauthorizedOperation.PermissionDenied	CAM authentication failed.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud