API 中心
有奖：语音产品征文挑战赛火热进行中> HOT
文档中心 > API 中心 > TDSQL-C MySQL 版 > 数据库代理相关接口 > 查询数据库代理列表

查询数据库代理列表

最近更新时间：2024-03-12 01:23:24

我的收藏

本页目录：

1. 接口描述

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

查询数据库代理列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeProxies。
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 。
ClusterId 否 String 集群ID（该参数必传，例如cynosdbmysql-xxxxxx）
示例值：cynosdbmysql-xxxxxx
Limit 否 Integer 返回数量，默认为 20，最大值为 100
示例值：20
Offset 否 Integer 记录偏移量，默认值为0
示例值：0
OrderBy 否 String 排序字段，取值范围：
  • CREATETIME：创建时间
  • PERIODENDTIME：过期时间

    • 示例值："CREATETIME"
    OrderByType 否 String 排序类型，取值范围：
  • ASC：升序排序
  • DESC：降序排序

    • 示例值："DESC"
    Filters.N 否 Array of QueryParamFilter 搜索条件，若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。

    3. 输出参数

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

    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-xx"
            ],
            "ExactMatch": true
        }
    ],
    "Offset": 0,
    "OrderByType": "desc"
}

    输出示例

    {
    "Response": {
        "TotalCount": 0,
        "ProxyGroupInfos": [
            {
                "ProxyGroup": {
                    "ProxyGroupId": "abc",
                    "ProxyNodeCount": 0,
                    "Status": "abc",
                    "Region": "abc",
                    "Zone": "abc",
                    "CurrentProxyVersion": "abc",
                    "ClusterId": "abc",
                    "AppId": 0,
                    "OpenRw": "abc"
                },
                "ProxyGroupRwInfo": {
                    "ConsistencyType": "abc",
                    "ConsistencyTimeOut": 0,
                    "WeightMode": "abc",
                    "FailOver": "abc",
                    "AutoAddRo": "abc",
                    "InstanceWeights": [
                        {
                            "InstanceId": "abc",
                            "Weight": 0
                        }
                    ],
                    "OpenRw": "abc",
                    "RwType": "abc",
                    "TransSplit": true,
                    "AccessMode": "abc"
                },
                "ProxyNodes": [
                    {
                        "ProxyNodeId": "abc",
                        "ProxyNodeConnections": 0,
                        "Cpu": 0,
                        "Mem": 0,
                        "Status": "abc",
                        "ProxyGroupId": "abc",
                        "ClusterId": "abc",
                        "AppId": 0,
                        "Region": "abc",
                        "Zone": "abc",
                        "OssProxyNodeName": "abc"
                    }
                ],
                "ConnectionPool": {
                    "OpenConnectionPool": "abc",
                    "ConnectionPoolType": "abc",
                    "ConnectionPoolTimeOut": 0
                },
                "NetAddrInfos": [
                    {
                        "Vip": "abc",
                        "Vport": 0,
                        "WanDomain": "abc",
                        "WanPort": 0,
                        "NetType": "abc",
                        "UniqSubnetId": "abc",
                        "UniqVpcId": "abc",
                        "Description": "abc",
                        "WanIP": "abc",
                        "WanStatus": "abc",
                        "InstanceGroupId": "abc"
                    }
                ],
                "Tasks": [
                    {
                        "TaskId": 0,
                        "TaskType": "abc",
                        "TaskStatus": "abc",
                        "ObjectId": "abc",
                        "ObjectType": "abc"
                    }
                ]
            }
        ],
        "ProxyNodeInfos": [
            {
                "ProxyNodeId": "abc",
                "ProxyNodeConnections": 0,
                "Cpu": 0,
                "Mem": 0,
                "Status": "abc",
                "ProxyGroupId": "abc",
                "ClusterId": "abc",
                "AppId": 0,
                "Region": "abc",
                "Zone": "abc",
                "OssProxyNodeName": "abc"
            }
        ],
        "RequestId": "abc"
    }
}

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation.CamCheckResourceError 获取权限失败，请稍后重试。如果持续不成功，请联系客服进行处理。
    FailedOperation.DatabaseAccessError 数据库访问失败，请稍后重试。如果持续不成功，请联系客服进行处理。
    FailedOperation.OperationFailedError 操作失败，请稍后重试。如果持续不成功，请联系客服进行处理。
    InternalError.DbOperationFailed 查询数据库失败。
    InternalError.SystemError 系统内部错误。
    InvalidParameterValue.IllegalOrderBy 无效的排序字段。
    InvalidParameterValue.InvalidParameterValueError 参数值无效。
    InvalidParameterValue.ParamBothSetError 该两个参数不可以同时设定。
    UnauthorizedOperation.PermissionDenied CAM鉴权不通过。
    中国站