1. 接口描述
接口请求域名： postgres.tencentcloudapi.com 。
本接口（ModifyDBProxy）用于修改数据库代理（Proxy）。支持两种模式：①仅修改 Description 时同步生效，不下单，DealName 为空；②变更 Proxy 节点规格或数量（ProxyNodeCustom）时走计费下单流程，异步触发变配任务，返回 DealName。可通过 SwitchTag 控制变配执行时机。
默认接口请求频率限制：20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyDBProxy。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| DBInstanceId | 是 | String | 实例 ID，格式形如：postgres-xxxxxxxx 示例值：postgres-ll68q8z3 |
| ProxyGroupId | 否 | String | Proxy 实例 ID，格式形如：proxy-xxxxxxxx；不传时若实例下仅有一个 Proxy 则修改该 Proxy 示例值：proxy-ex9u2u4j |
| Description | 否 | String | Proxy 描述信息，长度范围 [0, 256] 示例值：rename proxy |
| ProxyNodeCustom.N | 否 | Array of ProxyNodeCustom | Proxy 节点变配规格列表，按可用区分组；变配时必填 |
| ReloadBalance | 否 | String | 负载均衡刷新策略：auto-自动；manual-手动；默认 auto 示例值：auto |
| SwitchTag | 否 | Integer | 变配执行时机：0-立即执行（默认），1-维护时间窗内执行，2-指定时间窗执行（需配合 SwitchStartTime/SwitchEndTime） 示例值：0 |
| SwitchStartTime | 否 | String | 指定时间窗执行的开始时间，格式 HH:MM:SS，仅 SwitchTag=2 时生效 示例值：02:00:00 |
| SwitchEndTime | 否 | String | 指定时间窗执行的结束时间，格式 HH:MM:SS，仅 SwitchTag=2 时生效 示例值：06:00:00 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DealName | String | 订单号，仅变配（节点规格/数量变更）下单成功时返回；仅修改 Description 时不下单，本字段为空。 示例值：20260523594022883452641 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 Proxy 节点变配
变配 Proxy 节点规格与数量，下单返回 DealName
输入示例
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDBProxy
<公共请求参数>
{
"DBInstanceId": "postgres-ll68q8z3",
"ProxyGroupId": "proxygroup-1x2edzxh",
"ProxyNodeCustom": [
{
"NodeCount": 4,
"Zone": "ap-guangzhou-3",
"Cpu": 4,
"Mem": 8
}
],
"SwitchTag": 0
}输出示例
{
"Response": {
"DealName": "20260523594022883452641",
"RequestId": "ba9bf5a6-907a-43de-b81b-41c7430c1f6c"
}
}示例2 仅修改 Proxy 描述
仅修改描述，不下单，无 DealName 返回
输入示例
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDBProxy
<公共请求参数>
{
"DBInstanceId": "postgres-ll68q8z3",
"ProxyGroupId": "proxygroup-1x2edzxh",
"Description": "rename proxy"
}输出示例
{
"Response": {
"RequestId": "ba9bf5a6-907a-43de-b81b-41c7430c1f6c"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.DatabaseAccessError | 管控元数据库访问失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| FailedOperation.FailedOperationError | 操作失败，请稍后重试。 |
| FailedOperation.FlowCreateError | 创建流程失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| FailedOperation.ModifyResourceError | 实例配置变更失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| InvalidParameter.ParameterCheckError | 参数检查失败。 |
| InvalidParameterValue.InvalidParameterValueError | 参数值有误。 |
| OperationDenied.InstanceAccessDeniedError | 您没有权限操作当前资源。 |
| OperationDenied.InstanceStatusLimitOpError | 实例状态限制当前操作。 |
| ResourceNotFound.InstanceNotFoundError | 实例不存在。 |
