创建代理实例
更新时间：2023-12-25
接口说明
创建代理实例
请求结构
Plain Text
1POST /v{version}/instance?rdsproxy&clientToken={clientToken} HTTP/1.1
2HOST: rds.bj.baidubce.com
3Authorization: authorization string
4{
5 "billing":{
6 "paymentTiming" : paymentTiming
7 },
8 "sourceInstanceId" : sourceInstanceId,
9 "instanceName" : instanceName,
10 "nodeAmount" : nodeAmount,
11 "zoneNames" : [zoneName],
12 "vpcId" : vpcId ,
13 "subnets" : [
14 {
15 "zoneName": zoneName,
16 "subnetId": subnetId
17 }
18 ],
19 "isDirectPay" : isDirectPay,
20 "ovip" : "ovip",
21 "entryPort" : entryPort,
22 "resourceGroupId" : "resourceGroupId"
23}请求参数
参数名称 |
类型 |
是否必须 |
参数位置 |
描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API 版本号 |
| clientToken | String | 是 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串。 |
| billing | Billing | 是 | RequestBody参数 | 计费相关参数。 代理实例只支持后付费Postpaid。结构及取值参考 |
| sourceInstanceId | String | 是 | RequestBody参数 | 主实例ID |
| instanceName | String | 否 | RequestBody参数 | 用户自定义实例名，要求： 1）允许小写字母、数字； 2）长度限制为1~32； 默认为rdsproxy |
| nodeAmount | Integer | 是 | RequestBody参数 | 代理实例节点数。取值范围2，4，6，8，16。 |
| zoneNames | List <String> | 否 | RequestBody参数 | 指定zone信息，默认为空，由系统自动选择，可通过调用查询可用区列表接口查询可用区列表。zoneName命名规范是小写的“国家-region-可用区序列"，例如北京可用区A为"cn-bj-a"。 建议与主实例的可用区保持一致。 |
| vpcId | String | 否 | RequestBody参数 | 与主实例vpcId相同。 |
| isDirectPay | Boolean | 否 | RequestBody参数 | 是否进行直接支付，默认false，设置为直接支付的变配订单会直接扣款，不需要在走支付逻辑。 |
| subnets | List <SubnetMap> | 否 | RequestBody参数 | 特定vpc内，可用区的subnetId；如果指定的vpcId为自定义vpc，则必须指定subnetId。可通过调用查询子网列表接口查询子网列表。 建议与主实例的子网保持一致。 |
| ovip | String | 否 | RequestBody参数 | RDS实例访问入口BLB的ovip，传该参数且值非空，会根据该值为blb的ovip去申请blb，否则申请blb随机分配IP。 |
| entryPort | Integer | 否 | RequestBody参数 | RDS实例访问入口BLB的端口，传该参数且值非空，会根据该值为blb的listener port去申请blb，否则默认3306，端口取值范围：1024-65535。 |
| resourceGroupId | String | 否 | RequestBody参数 | 资源分组Id，例如：RESG-bKMxbExtnoG。 |
Billing字段数据结构说明
参数名称 |
参数类型 |
是否必须 |
描述 |
示例值 |
|---|---|---|---|---|
| paymentTiming | String | 是 | 付款方式（后付费：Postpaid；只读实例只支持后付费） | Postpaid |
SubnetMap字段数据结构说明
参数名称 |
参数类型 |
是否必须 |
描述 |
示例值 |
|---|---|---|---|---|
| zoneName | String | 否 | 可用区 | cn-bj-a |
| subnetId | String | 否 | 子网ID | sbn-IyWRnII7 |
返回参数
参数名称 |
参数类型 |
描述 |
示例值 |
|---|---|---|---|
| instanceIds | List<String> | 实例ID列表 | rds-cwerfq23f |
| orderId | String | 订单ID | 11111111111111111111111111 |
请求示例
Plain Text
1POST /v1/instance?rdsproxy&clientToken=clientToken_example
2HOST: rds.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4{
5 "zoneNames" : [ "cn-bj-a" ],
6 "instanceName" : "name-01",
7 "vpcId" : "vpc-IyrqYIQ7",
8 "sourceInstanceId" : "rds-H8XLpvqX",
9 "isDirectPay" : false,
10 "subnets" : [ {
11 "subnetId" : "sbn-IyWRnII7",
12 "zoneName" : "cn-bj-a"
13 } ],
14 "nodeAmount" : 2,
15 "billing" : {
16 "paymentTiming" : "Postpaid"
17 }
18}返回示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
4Server: BWS
5{
6 "instanceIds" : ["rds-cwerfq23f" ],
7 "orderId": "11111111111111111111111111"
8}