帮你快速理解、总结文档立即下载
文档中心>API 中心>云数据库 PostgreSQL>数据库代理相关接口>修改代理地址配置

修改代理地址配置

最近更新时间：2026-08-24 02:38:02
我的收藏

本页目录：

1. 接口描述

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

修改代理地址配置

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

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

2. 输入参数

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

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

实例ID


示例值：postgres-2wvpv38j
AddressId 是 String

Proxy地址ID


示例值：proxyaddr-hw78kg1m
ProxyGroupId 否 String

Proxy代理组 ID（不传则默认操作该实例下唯一的代理）


示例值：proxy-nlpsb4jp
Description 否 String

地址描述/备注（最多 256 字符）


示例值：modify
ConnectionPool 否 Boolean

连接池开关

枚举值：

  • true： 开启
  • false： 关闭

示例值：false
WeightMode 否 String

权重模式

枚举值：

  • system： 系统自动分配权重
  • custom： 自定义权重，此模式下ProxyAllocation参数必传

默认值：system


示例值：custom
ProxyAllocation.N 否 Array of ProxyRoute

system

入参限制：路由权重列表。若 WeightMode 传的是system或不传 ，则传入的权重不生效，由系统分配默认权重。
RoAutoAdd 否 Boolean

新增只读实例是否自动加入当前连接地址，仅后续新建实例生效


示例值：false
LatencyRemove 否 Boolean

延迟剔除开关


示例值：false
LatencyRemoveTime 否 Integer

延迟剔除阈值，仅在延迟剔除开关打开时有效

单位：秒


示例值：10
MinRouteNum 否 Integer

最小保留路由数。在延迟/故障剔除时，至少保留的路由数量，防止所有节点被剔除导致服务不可用。


示例值：1
LoadBalancePolicy 否 Integer

负载均衡策略

枚举值：

  • 0： 按活跃连接数(默认)
  • 1： 按请求数

示例值：0

3. 输出参数

参数名称 类型 描述
TaskId Integer

异步任务 ID，用于 DescribeTasks 查询进度


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

4. 示例

示例1 修改读写分离参数

输入示例

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

{
    "DBInstanceId": "postgres-2wvpv38j",
    "AddressId": "proxyaddr-hw78kg1m",
    "ProxyGroupId": "proxy-nlpsb4jp",
    "Description": "modify",
    "ConnectionPool": false,
    "WeightMode": "custom",
    "ProxyAllocation": [
        {
            "NodeId": "postgres-2wvpv38j",
            "Role": "master",
            "Status": "online"
        }
    ],
    "RoAutoAdd": false,
    "LatencyRemove": false,
    "LatencyRemoveTime": 10,
    "MinRouteNum": 1
}

输出示例

{
    "Response": {
        "TaskId": 100201,
        "RequestId": "15624379-9192-459e-97f4-52cdc4043a3a"
    }
}

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.BizInvalidParameterValueError 参数值无效
InvalidParameterValue.InvalidParameterValueError 参数值有误。
OperationDenied.InstanceAccessDeniedError 您没有权限操作当前资源。
ResourceNotFound.InstanceNotFoundError 实例不存在。
中国站