1. 接口描述
接口请求域名: postgres.tencentcloudapi.com 。
本接口(CreateDBProxy)用于为指定的 PostgreSQL 实例创建数据库代理(Proxy)。走计费下单流程,下单成功后异步发起 Proxy 创建任务,同步返回订单号 DealName 与 Proxy 实例 ID ProxyGroupId。当前仅支持后付费按量计费。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateDBProxy。 |
| Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| DBInstanceId | 是 | String | 实例 ID,格式形如:postgres-xxxxxxxx 示例值:postgres-ll68q8z3 |
| VpcId | 是 | String | Proxy 所在私有网络 ID,需与主实例所在 VPC 一致 示例值:vpc-evvog2gd |
| SubnetId | 是 | String | Proxy 所在私有网络子网 ID 示例值:subnet-clk8il4i |
| ProxyNodeCustom.N | 是 | Array of ProxyNodeCustom | Proxy 节点自定义规格列表,至少一个元素,按可用区分组 |
| SecurityGroup.N | 否 | Array of String | Proxy 关联的安全组 ID 列表 示例值:["sg-xxxxxxxx"] |
| Description | 否 | String | Proxy 描述信息 长度范围:[0, 256] 示例值:test proxy |
| ConnectionPoolLimit | 否 | Integer | 连接池阈值(连接数),单位:个 示例值:200 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DealName | String | 订单号,下单成功返回。 示例值:20260523594022883452641 |
| ProxyGroupId | String | 创建出的 Proxy 实例 ID,格式形如:proxy-xxxxxxxx。 示例值:proxy-70x0pl73 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建数据库代理
为指定 PG 实例创建数据库代理
输入示例
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDBProxy
<公共请求参数>
{
"DBInstanceId": "postgres-ll68q8z3",
"VpcId": "vpc-evvog2gd",
"SubnetId": "subnet-clk8il4i",
"ProxyNodeCustom": [
{
"NodeCount": 2,
"Zone": "ap-guangzhou-3",
"Cpu": 2,
"Mem": 4
}
],
"SecurityGroup": [
"sg-xxxxxxxx"
],
"Description": "test proxy",
"ConnectionPoolLimit": 200
}
输出示例
{
"Response": {
"DealName": "20260523594022883452641",
"ProxyGroupId": "proxygroup-1x2edzxh",
"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 | 创建流程失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
| InvalidParameter.ParameterCheckError | 参数检查失败。 |
| InvalidParameterValue.InvalidParameterValueError | 参数值有误。 |
| OperationDenied.InstanceAccessDeniedError | 您没有权限操作当前资源。 |
| OperationDenied.InstanceStatusDeniedError | 实例状态限制当前操作。 |
| OperationDenied.InstanceStatusLimitOpError | 实例状态限制当前操作。 |
| ResourceNotFound.InstanceNotFoundError | 实例不存在。 |