查询数据库代理列表

1. 接口描述

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

本接口（DescribeProxies）用于查询数据库代理列表。

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 查询数据库代理列表

查询数据库代理

输入示例

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

{
    "OrderBy": "createTime",
    "ClusterId": "cynosdbmysql-xx",
    "Limit": 0,
    "Filters": [
        {
            "Values": [
                "proxyGroupId"
            ],
            "Names": [
                "cynosdbmysql-proxy-tshj6btw"
            ],
            "ExactMatch": true
        }
    ],
    "Offset": 0,
    "OrderByType": "desc"
}

输出示例

{
    "Response": {
        "TotalCount": 2,
        "ProxyGroupInfos": [
            {
                "ConnectionPool": {
                    "ConnectionPoolTimeOut": 30,
                    "ConnectionPoolType": "SessionConnectionPool",
                    "OpenConnectionPool": "yes"
                },
                "NetAddrInfos": [
                    {
                        "Description": "external-ro new",
                        "InstanceGroupId": "cynosdbmysql-grp-nsiuj4aj",
                        "NetType": "",
                        "UniqSubnetId": "subnet-pmqqss72",
                        "UniqVpcId": "vpc-gvelzo5j",
                        "Vip": "11.2.1.43",
                        "Vport": 3306,
                        "WanDomain": "test.wan.domain",
                        "WanIP": "11.2.3.43",
                        "WanPort": 3306,
                        "WanStatus": "open"
                    }
                ],
                "ProxyGroup": {
                    "AppId": 1772344699,
                    "ClusterId": "cynosdbmysql-i2weamox",
                    "CurrentProxyVersion": "1.3.11",
                    "OpenRw": "yes",
                    "ProxyGroupId": "cynosdbmysql-proxy-mdhg55su",
                    "ProxyNodeCount": 4,
                    "Region": "ap-guangzhou",
                    "Status": "running",
                    "Zone": "ap-guangzhou-6"
                },
                "ProxyGroupRwInfo": {
                    "AccessMode": "balance",
                    "AutoAddRo": "no",
                    "ConsistencyTimeOut": 0,
                    "ConsistencyType": "eventual",
                    "FailOver": "no",
                    "InstanceWeights": [
                        {
                            "InstanceId": "cynosdbmysql-ins-ka2i3m48",
                            "Weight": 1
                        }
                    ],
                    "OpenRw": "yes",
                    "RwType": "READONLY",
                    "TransSplit": false,
                    "WeightMode": "system"
                },
                "ProxyNodes": [
                    {
                        "AppId": 1772344699,
                        "ClusterId": "cynosdbmysql-i2weamox",
                        "Cpu": 2,
                        "Mem": 4000,
                        "OssProxyNodeName": "cynosdbmysql-proxyNode-q52v1wp4",
                        "ProxyGroupId": "cynosdbmysql-proxy-mdhg57su",
                        "ProxyNodeConnections": 157,
                        "ProxyNodeId": "cynosdbmysql-proxyNode-pv4hg4na",
                        "Region": "ap-guangzhou",
                        "Status": "running",
                        "Zone": "ap-guangzhou-6"
                    }
                ],
                "Tasks": [
                    {
                        "TaskId": 123124,
                        "TaskType": "taskModifyProxyRwSplit",
                        "TaskStatus": "processing",
                        "ObjectId": "cynosdbmysql-proxy-mdhg57su",
                        "ObjectType": "taskObjTypeCluster"
                    }
                ]
            }
        ],
        "ProxyNodeInfos": [
            {
                "ProxyNodeId": "cynosdbmysql-proxyNode-pv4hg4na",
                "ProxyNodeConnections": 157,
                "Cpu": 2,
                "Mem": 4000,
                "Status": "running",
                "ProxyGroupId": "cynosdbmysql-proxy-mdhg57su",
                "ClusterId": "cynosdbmysql-i2weamox",
                "AppId": 1772344699,
                "Region": "ap-guangzhou",
                "Zone": "ap-guangzhou-6",
                "OssProxyNodeName": "cynosdbmysql-proxyNode-q52v1wp4"
            }
        ],
        "RequestId": "ed0bd4ca-b5c0-4230-a8b5-6d2dc5ec1eb0"
    }
}

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. 错误码

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