云数据库 MySQL 查询数据库代理详情-数据库代理相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： cdb.tencentcloudapi.com 。

查询数据库代理详情信息

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeCdbProxyInfo。
Version	是	String	公共参数，本接口取值：2017-03-20。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	实例ID 示例值：cdb-aykuksx3
ProxyGroupId	否	String	代理组ID 示例值：proxy-ixw3ll2d

3. 输出参数

参数名称	类型	描述
Count	Integer	代理组数量注意：此字段可能返回 null，表示取不到有效值。示例值：1
ProxyInfos	Array of ProxyGroupInfo	代理组信息注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询代理信息

查询代理信息

输入示例

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

{
    "InstanceId": "cdb-aykuksx3"
}

输出示例

{
    "Response": {
        "Count": 1,
        "ProxyInfos": [
            {
                "ConnectionPoolLimit": 5,
                "ProxyAddress": [
                    {
                        "AutoAddRo": true,
                        "ConnectionPool": false,
                        "Desc": "",
                        "FailOver": true,
                        "IsKickOut": false,
                        "MaxDelay": 0,
                        "MinCount": 0,
                        "ProxyAddressId": "proxyaddr-test",
                        "AccessMode": "balance",
                        "ProxyAllocation": [
                            {
                                "ProxyInstance": [
                                    {
                                        "InstanceId": "cdb-test",
                                        "InstanceName": "测试",
                                        "InstanceType": "1",
                                        "Region": "ap-nanjing",
                                        "Status": 1,
                                        "Weight": 0,
                                        "Zone": "ap-nanjing-1"
                                    }
                                ],
                                "Region": "ap-nanjing",
                                "Zone": "ap-nanjing-1"
                            }
                        ],
                        "ReadOnly": false,
                        "TransSplit": false,
                        "UniqSubnetId": "subnet-test",
                        "UniqVpcId": "vpc-test",
                        "VPort": 3306,
                        "Vip": "10.0.0.0",
                        "WeightMode": "custom"
                    }
                ],
                "ProxyGroupId": "proxy-mfxftest",
                "ProxyNode": [
                    {
                        "Cpu": 2,
                        "Mem": 4000,
                        "ProxyId": "proxynode-test",
                        "Region": "ap-nanjing",
                        "Status": "online",
                        "Zone": "ap-nanjing-1",
                        "Connection": 1
                    }
                ],
                "ProxyVersion": "1.3.7",
                "Status": "online",
                "SupportCreateProxyAddress": false,
                "SupportUpgradeProxyMysqlVersion": "20211030",
                "SupportUpgradeProxyVersion": "1.3.7",
                "TaskStatus": "ProxyModifyAddress"
            }
        ],
        "RequestId": "69d4c061-9730-4e2f-btttbb2-a74624bc9a6c"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.DescribeProxyGroupError	查询数据库代理失败。
InternalError.HttpError	Http请求异常。
InternalError.InternalHttpServerError	请求执行异常。
InternalError.UnknownError	未知错误。
InvalidParameter.ControllerNotFoundError	未找到该接口。

查询数据库代理详情

本页目录：