有奖捉虫:行业应用 & 管理与支持文档专题 HOT
文档中心 > TDSQL-C MySQL 版 > API 文档 > 其他接口 > 查询可售卖地域可用区信息。

1. 接口描述

接口请求域名: cynosdb.tencentcloudapi.com 。

本接口(DescribeZones)用于查询可售卖地域可用区信息。

默认接口请求频率限制:1000次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeZones。
Version String 公共参数,本接口取值:2019-01-07。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-nanjing, ap-seoul, ap-shanghai, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley 。
IncludeVirtualZones Boolean 是否包含虚拟区
示例值:false
ShowPermission Boolean 是否展示地域下所有可用区,并显示用户每个可用区权限
示例值:false

3. 输出参数

参数名称 类型 描述
RegionSet Array of SaleRegion 地域信息
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询可售卖地域可用区信息

仅查看用户有权限的可用区

输入示例

POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeZones
<公共请求参数>

{}

输出示例

{
    "Response": {
        "RegionSet": [
            {
                "DbType": "MYSQL",
                "Region": "ap-guangzhou",
                "RegionId": 100001,
                "Modules": [
                    {
                        "ModuleName": "is.disable.wan",
                        "IsDisable": "yes"
                    }
                ],
                "RegionZh": "广州",
                "ZoneSet": [
                    {
                        "PhysicalZone": "ap-guangzhou-2",
                        "Zone": "ap-guangzhou-2",
                        "IsSupportServerless": 0,
                        "ZoneId": 100003,
                        "IsSupportNormal": 0,
                        "ZoneZh": "广州二区",
                        "HasPermission": true,
                        "IsWholeRdmaZone": "abc"
                    },
                    {
                        "PhysicalZone": "ao-guangzhou-5",
                        "Zone": "ap-guangzhou-5",
                        "IsSupportServerless": 0,
                        "ZoneId": 100004,
                        "IsSupportNormal": 0,
                        "ZoneZh": "广州五区",
                        "HasPermission": true,
                        "IsWholeRdmaZone": "abc"
                    }
                ]
            },
            {
                "DbType": "MYSQL",
                "Region": "ap-beijing",
                "RegionId": 8,
                "Modules": [
                    {
                        "ModuleName": "is.disable.wan",
                        "IsDisable": "no"
                    }
                ],
                "RegionZh": "北京",
                "ZoneSet": [
                    {
                        "PhysicalZone": "ap-beijing-5",
                        "Zone": "ap-beijing-5",
                        "IsSupportServerless": 0,
                        "ZoneId": 800001,
                        "IsSupportNormal": 0,
                        "ZoneZh": "北京五区",
                        "HasPermission": true,
                        "IsWholeRdmaZone": "abc"
                    }
                ]
            }
        ],
        "RequestId": "1qwert-123-asbc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.DatabaseAccessError 数据库访问失败,请稍后重试。如果持续不成功,请联系客服进行处理。
InternalError.DbOperationFailed 查询数据库失败。
InternalError.InternalHttpServerError http请求执行异常。
UnauthorizedOperation.PermissionDenied CAM鉴权不通过。