帮你快速理解、总结文档立即下载
文档中心>云数据库 PostgreSQL>API 文档>数据库代理相关接口>查询数据库代理

查询数据库代理

最近更新时间：2026-07-29 02:49:36

我的收藏

本页目录：

1. 接口描述

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

本接口（DescribeDBProxy）用于查询指定 PostgreSQL 实例下的数据库代理（Proxy）信息，包含 Proxy 节点列表与接入地址列表。可选传入 ProxyGroupId 精确查询某一 Proxy；不传则返回该实例下的全部 Proxy。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeDBProxy。
Version 是 String 公共参数，本接口取值：2017-03-12。
Region 是 String 公共参数，详见产品支持的 地域列表。
DBInstanceId 是 String

实例 ID，格式形如：postgres-xxxxxxxx


示例值：postgres-oul13k0b
ProxyGroupId 否 String

Proxy 实例 ID，格式形如：proxy-xxxxxxxx；不传则查询该实例下全部 Proxy


示例值：proxy-daqueu21

3. 输出参数

参数名称 类型 描述
Count Integer

Proxy 实例数量。


示例值：1
ProxyInfos Array of ProxyGroupInfo

Proxy 实例详情列表。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询数据库代理

查询指定 PG 实例下的全部 Proxy 信息

输入示例

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

{
    "DBInstanceId": "postgres-oul13k0b"
}

输出示例

{
    "Response": {
        "Count": 1,
        "ProxyInfos": [
            {
                "ConnectionPoolLimit": 0,
                "CreateTime": "2026-06-17 16:46:12",
                "Description": "",
                "ProxyAddressSet": [
                    {
                        "AddressId": "proxyaddr-80ab0kho",
                        "ConnectionPool": true,
                        "ConnectionPoolLimit": 300,
                        "Description": "",
                        "Routes": [
                            {
                                "NodeId": "postgres-oul13k0b",
                                "Role": "master",
                                "Status": "online",
                                "Weight": 100
                            }
                        ],
                        "SubnetId": "6888276",
                        "Vip": "10.0.0.91",
                        "VpcId": "12115942",
                        "Vport": 5432
                    }
                ],
                "ProxyGroupId": "proxy-i36xgkkt",
                "ProxyNodeSet": [
                    {
                        "Connection": 0,
                        "Cpu": 2,
                        "Mem": 4000,
                        "ProxyNodeId": "proxynode-d1d9to0k",
                        "Status": "online",
                        "Zone": "ap-guangzhou-3"
                    }
                ],
                "ProxyVersion": "1.4.9",
                "Status": "online",
                "TaskStatus": ""
            }
        ],
        "RequestId": "81a642d4-3ec9-43b3-b74e-be7b22dc391e"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameter.ParameterCheckError 参数检查失败。
InvalidParameterValue.InvalidParameterValueError 参数值有误。
ResourceNotFound.InstanceNotFoundError 实例不存在。
中国站