云数据库 MySQL

动态与公告

新手指引

产品简介

自研内核 TXSQL

购买指南

快速入门

操作指南

最佳实践

白皮书

故障处理

API 文档

常见问题

服务协议

通用参考

联系我们

词汇表
文档中心 > 云数据库 MySQL > API 文档 > 数据库代理相关接口 > 查询数据库代理

查询数据库代理

最近更新时间：2022-04-22 06:05:47

我的收藏

本页目录：

1. 接口描述

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

查询数据库代理（待下线，替换接口QueryCDBProxy）

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

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

2. 输入参数

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

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

3. 输出参数

参数名称 类型 描述
BaseGroup BaseGroupInfo 代理组基本信息
注意：此字段可能返回 null，表示取不到有效值。
Address Address 代理组地址信息
注意：此字段可能返回 null，表示取不到有效值。
ProxyNode ProxyNodeInfo 代理组节点信息
注意：此字段可能返回 null，表示取不到有效值。
RWInstInfo RWInfo 读写分析信息
注意：此字段可能返回 null，表示取不到有效值。
ConnectionPoolInfo ConnectionPoolInfo 连接池信息
注意：此字段可能返回 null，表示取不到有效值。
Count Integer 代理数量
注意：此字段可能返回 null，表示取不到有效值。
ProxyGroup Array of ProxyGroup 代理信息
注意：此字段可能返回 null，表示取不到有效值。
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询数据库代理

输入示例

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

{
    "InstanceId": "xx",
    "ProxyGroupId": "xx"
}

输出示例

{
  "Response": {
    "Count": 1,
    "RWInstInfo": {
      "MaxDelay": 1,
      "AutoAddRo": true,
      "IsKickOut": true,
      "FailOver": true,
      "RWInstInfo": {},
      "MinCount": 1,
      "WeightMode": "xx",
      "InstCount": 1
    },
    "ProxyNode": {
      "ProxyNodeId": "xx",
      "ProxyNodeMem": 1,
      "ProxyNodeConnections": 1,
      "ProxyNodeCpu": 1,
      "ProxyStatus": "xx"
    },
    "ConnectionPoolInfo": {
      "ConnectionPoolType": "xx",
      "PoolConnectionTimeOut": 0,
      "ConnectionPool": true
    },
    "RequestId": "xx",
    "Address": {
      "UniqVpcId": "xx",
      "VPort": 1,
      "Vip": "xx",
      "UniqSubnet": "xx",
      "Desc": "xx"
    },
    "ProxyGroup": [
      {
        "ConnectionPoolInfo": {
          "ConnectionPoolType": "xx",
          "PoolConnectionTimeOut": 0,
          "ConnectionPool": false
        },
        "RWInstInfo": {
          "MaxDelay": 1,
          "AutoAddRo": true,
          "IsKickOut": true,
          "FailOver": true,
          "RWInstInfo": {},
          "MinCount": 1,
          "WeightMode": "xx",
          "InstCount": 1
        },
        "BaseGroup": {
          "Status": "xx",
          "CurrentProxyVersion": "xx",
          "ProxyGroupId": "xx",
          "Zone": "xx",
          "Region": "xx",
          "NodeCount": 1,
          "SupportUpgradeProxyVersion": "xx",
          "OpenRW": true
        },
        "ProxyNode": {
          "ProxyNodeId": "xx",
          "ProxyNodeMem": 1,
          "ProxyNodeConnections": 1,
          "ProxyNodeCpu": 1,
          "ProxyStatus": "xx"
        },
        "Address": {
          "UniqVpcId": "xx",
          "VPort": 1,
          "Vip": "xx",
          "UniqSubnet": "xx",
          "Desc": "xx"
        }
      }
    ],
    "BaseGroup": {
      "Status": "xx",
      "CurrentProxyVersion": "xx",
      "ProxyGroupId": "xx",
      "Zone": "xx",
      "Region": "xx",
      "NodeCount": 1,
      "SupportUpgradeProxyVersion": "xx",
      "OpenRW": true
    }
  }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.DBRecordNotExistError 数据库记录不存在。
目录
中国站