操作指南

API 文档

查询代理详情

最近更新时间:2022-05-17 06:05:52

我的收藏

1. 接口描述

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

查询代理详情

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

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

2. 输入参数

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

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

3. 输出参数

参数名称 类型 描述
Count Integer 代理数量
注意:此字段可能返回 null,表示取不到有效值。
ProxyGroup Array of ProxyGroups 代理信息
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询代理详情

输入示例

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

{
    "InstanceId": "cdb-test",
    "ProxyGroupId": "proxy-test"
}

输出示例

{
  "Response": {
    "Count": 1,
    "ProxyGroup": [
      {
        "Address": [
          {
            "Desc": "",
            "UniqSubnet": "subnet-test",
            "UniqVpcId": "vpc-test",
            "VPort": 3306,
            "Vip": "172.16.48.49"
          }
        ],
        "BaseGroup": {
          "CurrentProxyVersion": "1.0.1",
          "NodeCount": 2,
          "OpenRW": false,
          "ProxyGroupId": "proxy-test",
          "Region": "ap-guangzhou",
          "Status": "online",
          "SupportUpgradeProxyVersion": "1.0.1",
          "Zone": "ap-guangzhou-6"
        },
        "ConnectionPoolInfo": {
          "ConnectionPool": false,
          "ConnectionPoolType": "",
          "PoolConnectionTimeOut": 0
        },
        "ProxyNode": [
          {
            "ProxyNodeConnections": 2,
            "ProxyNodeId": "proxynode-test",
            "ProxyStatus": "online"
          },
          {
            "ProxyNodeConnections": 2,
            "ProxyNodeId": "proxynode-test",
            "ProxyStatus": "online"
          }
        ],
        "RWInstInfo": {
          "AutoAddRo": false,
          "FailOver": false,
          "InstCount": 0,
          "IsKickOut": false,
          "MaxDelay": 0,
          "MinCount": 0,
          "RWInstInfo": [],
          "WeightMode": ""
        }
      }
    ],
    "RequestId": "733f71d8-6c3a-419e-830f-4471c5bc2791"
  }
}

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 数据库记录不存在。
InternalError.HttpError Http请求异常。
InternalError.UnknownError 未知错误。
InvalidParameter.ExceptionParam 异常参数。
目录