1. 接口描述
接口请求域名: postgres.tencentcloudapi.com 。
本接口(CreateDBProxyAddress)用于为指定实例的数据库代理创建连接地址。该接口为异步接口,调用成功后返回 TaskId,可通过 DescribeTasks 接口查询任务执行进度。
支持同时配置读写分离策略,包括权重模式、路由分配、延迟剔除、故障转移等高级功能。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateDBProxyAddress。 |
| Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| DBInstanceId | 是 | String | 实例 ID,指定要创建代理地址的目标实例 示例值:postgres-2wvpv38j |
| VpcId | 是 | String | VPC ID,代理地址所属的私有网络 示例值:vpc-1dq8ehm3 |
| SubnetId | 是 | String | 子网 ID,代理地址所属的子网 示例值:subnet-6yui3ok8 |
| ProxyGroupId | 否 | String | 代理组 ID。不传则按实例自动查找其默认代理组 示例值:proxy-nlpsb4jp |
| SecurityGroup.N | 否 | Array of String | 安全组 ID 列表,用于代理地址的网络安全控制 示例值:["sg-9rlup3c5"] |
| Description | 否 | String | 代理地址备注信息,最长 256 个字符 示例值:create new address |
| ConnectionPool | 否 | Boolean | 连接池开关。true:开启连接池;false:关闭连接池 示例值:true |
| WeightMode | 否 | String | 权重模式。取值:
示例值:custom |
| ProxyAllocation.N | 否 | Array of ProxyRoute | 路由权重列表。WeightMode 为 custom 时必填。若WeightMode传system或不传 ,则传入的权重不生效,由系统分配默认权重。 |
| RoAutoAdd | 否 | Boolean | 是否自动将新增的只读实例加入读写分离。true:自动加入;false:不自动加入 示例值:true |
| LatencyRemove | 否 | Boolean | 延迟剔除开关。true:开启延迟剔除,当只读实例延迟超过阈值时自动剔除路由;false:关闭延迟剔除。开启时 LatencyRemoveTime 必填 示例值:true |
| LatencyRemoveTime | 否 | Integer | 延迟剔除阈值,单位秒,取值范围 [1, 10000]。LatencyRemove 为 true 时必填 示例值:10 |
| MinRouteNum | 否 | Integer | 最小路由节点数,取值范围 [0, 256]。用于防止延迟剔除将所有节点剔除后的兜底策略 示例值:1 |
| LoadBalancePolicy | 否 | Integer | 负载均衡策略 枚举值:
示例值:1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | Integer | 异步任务 ID。可通过 DescribeTasks 接口查询任务执行进度 示例值:100200 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建Proxy连接地址
输入示例
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDBProxyAddress
<公共请求参数>
{
"DBInstanceId": "postgres-2wvpv38j",
"VpcId": "vpc-1dq8ehm3",
"SubnetId": "subnet-6yui3ok8",
"ProxyGroupId": "proxy-nlpsb4jp",
"SecurityGroup": [
"sg-9rlup3c5"
],
"Description": "create new address",
"ConnectionPool": true,
"WeightMode": "custom",
"ProxyAllocation": [
{
"NodeId": "postgres-2wvpv38j",
"Role": "master",
"Weight": 100,
"Status": "online"
}
],
"RoAutoAdd": true,
"LatencyRemove": true,
"LatencyRemoveTime": 10,
"MinRouteNum": 1
}
输出示例
{
"Response": {
"TaskId": 100200,
"RequestId": "d55c34b5-dfe0-43bf-96e8-df7880f9bace"
}
}
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 | 操作失败,请稍后重试。 |
| FailedOperation.FlowCreateError | 创建流程失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
| InternalError.DatabaseAccessError | 数据库访问异常,请检查连接后重试 |
| InvalidParameter.ParameterCheckError | 参数检查失败。 |
| InvalidParameterValue.InvalidParameterValueError | 参数值有误。 |
| OperationDenied.InstanceStatusLimitOpError | 实例状态限制当前操作。 |
| ResourceNotFound.InstanceNotFoundError | 实例不存在。 |