1. 接口描述
接口请求域名: postgres.tencentcloudapi.com 。
本接口(DestroyDBProxy)用于销毁指定的数据库代理(Proxy)。接口仅返回 RequestId,销毁动作由计费回调异步触发 ProxyDestroy 任务,内部统一完成「隔离 + 销毁」全部步骤(释放 VIP、解绑安全组、回收资源、上报计费等),用户无需先调用隔离接口。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DestroyDBProxy。 |
| Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| DBInstanceId | 是 | String | 实例 ID,格式形如:postgres-xxxxxxxx 示例值:postgres-ll68q8z3 |
| ProxyGroupId | 否 | String | Proxy 实例 ID,格式形如:proxy-xxxxxxxx;不传时若实例下仅有一个 Proxy 则销毁该 Proxy,存在多个 Proxy 必须显式传入 示例值:proxy-d79vccld |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 销毁数据库代理
销毁指定数据库代理实例
输入示例
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DestroyDBProxy
<公共请求参数>
{
"DBInstanceId": "postgres-ll68q8z3",
"ProxyGroupId": "proxygroup-1x2edzxh"
}
输出示例
{
"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.FailedOperationError | 操作失败,请稍后重试。 |
| InvalidParameter.ParameterCheckError | 参数检查失败。 |
| OperationDenied.InstanceAccessDeniedError | 您没有权限操作当前资源。 |
| OperationDenied.InstanceStatusLimitOpError | 实例状态限制当前操作。 |
| ResourceNotFound.InstanceNotFoundError | 实例不存在。 |