创建只读实例
更新时间：2023-08-22
接口说明
创建只读实例
请求结构
POST /v{version}/instance?readReplica&clientToken={clientToken} HTTP/1.1
HOST: rds.bj.baidubce.com
Authorization: authorization string
{
"billing":{
"paymentTiming" : paymentTiming,
"reservation" : {
"reservationLength" : reservationLength
}
},
"sourceInstanceId" : sourceInstanceId,
"instanceName" : instanceName,
"cpuCount":cpuCount,
"memoryCapacity" : memoryCapacity,
"volumeCapacity" : volumeCapacity,
"diskIoType" : "diskIoType",
"zoneNames" : [zoneName],
"vpcId" : vpcId ,
"isDirectPay" : isDirectPay,
"subnets" : [
{
"zoneName" : zoneName,
"subnetId" : subnetId
}
],
"ovip" : "ovip",
"entryPort" : entryPort,
"resourceGroupId" : "resourceGroupId"
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API 版本号 |
| clientToken | String | 是 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串。 |
| billing | Billing | 是 | RequestBody参数 | 计费相关参数。只读实例只支持后付费Postpaid。结构及取值参考 |
| sourceInstanceId | String | 是 | RequestBody参数 | 主实例ID |
| instanceName | String | 否 | RequestBody参数 | 用户自定义实例名，要求：1）允许小写字母、数字；2）长度限制为1~64；默认{engine} + {engineVersion} |
| cpuCount | Integer | 是 | RequestBody参数 | CPU核数。取值参考 |
| memoryCapacity | Integer | 是 | RequestBody参数 | 套餐内存大小，单位GB。取值参考 |
| volumeCapacity | Integer | 是 | RequestBody参数 | 套餐磁盘大小，单位GB，每5GB递增。不能小于主实例磁盘。范围参考 |
| diskIoType | String | 否 | RequestBody参数 | 磁盘类型。 normal_io : 本地盘ssd磁盘。 cloud_high : 高性能云磁盘。 cloud_nor : 通用型SSD。 cloud_enha: 增强型SSD |
| zoneNames | String | 否 | RequestBody参数 | 指定zone信息，默认为空，由系统自动选择，可通过调用查询可用区列表接口查询可用区列表。zoneName命名规范是小写的“国家-region-可用区序列"，例如北京可用区A为"cn-bj-a"。只读实例只能在单可用区中，故此处只能填写一个可用区。 |
| vpcId | String | 否 | RequestBody参数 | 与主实例 vpcId 相同 |
| isDirectPay | Boolean | 否 | RequestBody参数 | 是否进行直接支付，默认false，设置为直接支付的变配订单会直接扣款，不需要在走支付逻辑 |
| subnets | ListSubnetMap | 否 | RequestBody参数 | 特定vpc内，可用区的 subnetId；如果指定的 vpcId为自定义vpc，则必须指定 subnetId。可通过调用查询子网列表接口查询子网列表。只读实例只能在单可用区中，故此处只能填写一个 SubnetMap |
| 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 |
SubnetsItem字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| zoneName | String | 否 | 可用区 | cn-bj-a |
| subnetId | String | 否 | 子网ID | sbn-IyWRnII7 |
返回参数
| 参数名称 | 参数类型 | 描述 | 示例值 |
|---|---|---|---|
| instanceIds | List String | 实例ID列表 | rds-cwerfq23f |
| orderId | String | 订单ID | xxxxxxxxxxxx |
请求示例
POST /v1/instance?readReplica&clientToken=clientToken_example HTTP 1.1
HOST: rds.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
"billing":{
"paymentTiming":"Postpaid"
},
"purchaseCount":1,
"instanceName":"mysql56",
"sourceInstanceId": "rds-mudjimy0jbig",
"cpuCount":1,
"memoryCapacity":1,
"volumeCapacity":5,
"zoneNames":["cn-bj-a"],
"vpcId": "vpc-IyrqYIQ7",
"subnets":[
{
"zoneName": "cn-bj-a",
"subnetId": "sbn-IyWRnII7"
}
]
}返回示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Date: Wed, 08 Jul 2015 03:28:11 GMT
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
Server: BWS
{
"instanceIds" : [ "rds-cwerfq23f" ],
"orderId": "xxxxxxxxxxxxxxxxxxxxxx"
}