云数据库 PostgreSQL 关闭数据库代理地址

1. 接口描述

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

本接口用于关闭（删除）数据库代理的指定地址。接口为异步操作，返回 TaskId 供调用方通过 DescribeTasks 查询任务执行进度。约束：代理组至少保留一个地址，不允许删除最后一个地址。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CloseDBProxyAddress。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
DBInstanceId	是	String	实例 ID，指定要关闭代理地址的目标实例示例值：postgres-2wvpv38j
AddressId	是	String	代理地址 ID，指定要关闭（删除）的代理地址示例值：proxyaddr-0p3p1r76
ProxyGroupId	否	String	代理组 ID。不传则按实例自动查找其默认代理组示例值：proxy-89ap4mrx

3. 输出参数

参数名称	类型	描述
TaskId	Integer	异步任务 ID，可通过 DescribeFlow 查询任务进度示例值：100282
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 删除指定Proxy的连接地址

输入示例

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

{
    "DBInstanceId": "postgres-2wvpv38j",
    "AddressId": "proxyaddr-0p3p1r76",
    "ProxyGroupId": "proxy-89ap4mrx"
}

输出示例

{
    "Response": {
        "TaskId": 100282,
        "RequestId": "c390a1f8-1907-47fd-b40f-d9eb5de8d0d1"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.DatabaseAccessError	管控元数据库访问失败，请稍后重试。如果持续不成功，请联系客服进行处理。
FailedOperation.FlowCreateError	创建流程失败，请稍后重试。如果持续不成功，请联系客服进行处理。
InvalidParameter.ParameterCheckError	参数检查失败。
InvalidParameterValue.InvalidParameterValueError	参数值有误。
OperationDenied.InstanceStatusLimitOpError	实例状态限制当前操作。
ResourceNotFound.InstanceNotFoundError	实例不存在。

关闭数据库代理地址

本页目录：