创建只读实例
更新时间：2020-12-30
前提条件
需要在云数据库 RDS 主实例的基础上进行创建。
说明
- 仅数据库类型为 MySQL 的主实例支持创建只读实例
- 只读实例的数据库引擎和数据库版本与主实例相同，无需设置，主实例版本最低是 MySQL 5.6
- 只读实例的磁盘容量不能小于主实例的磁盘容量
- 只读实例的 vpcId 需跟主实例一致
- 一个云数据库 RDS 实例，最多只能有 5 个只读实例，且一次只能创建一个
- 只读实例只支持后付费方式购买
请求结构
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,
"zoneNames":[zoneName],
"vpcId": vpcId ,
"isDirectPay": isDirectPay,
"subnets":[
{
"zoneName": zoneName,
"subnetId": subnetId
}
],
"tags": [
{
"tagKey": tagKey,
"tagValue": tagValue
}
]
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | string | 是 | URL参数 | API 版本号 |
| clientToken | string | 是 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串。 |
| billing | billing | 是 | RequestBody参数 | 计费相关参数。只读实例只支持后付费Postpaid。结构及取值参考 |
| purchaseCount | int | 否 | RequestBody参数 | 批量创建云数据库 RDS 只读实例个数, 目前只支持一次创建一个. |
| sourceInstanceId | string | 是 | RequestBody参数 | 主实例ID |
| instanceName | string | 否 | RequestBody参数 | 用户自定义实例名，要求：1）允许小写字母、数字；2）长度限制为1~32；默认{engine} + {engineVersion} |
| cpuCount | int | 是 | RequestBody参数 | CPU核数。取值参考 |
| memoryCapacity | int | 是 | RequestBody参数 | 套餐内存大小，单位GB。取值参考 |
| volumeCapacity | int | 是 | RequestBody参数 | 套餐磁盘大小，单位GB，每5GB递增。不能小于主实例磁盘。范围参考 |
| 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。 |
| tags | List Tag | 否 | RequestBody参数 | 实例绑定的标签信息 |
SubnetMap
| 参数名称 | 类型 | 描述 |
|---|---|---|
| zoneName | String | 可用区 |
| subnetId | String | 子网Id |
Tag
| 参数名称 | 类型 | 描述 |
|---|---|---|
| tagKey | String | 标签key |
| tagValue | String | 标签value |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| instanceIds | List InstanceId | 由InstanceId组成的数组 |
请求示例
POST /v1/instance?readReplica&clientToken={be31b98c-5e41-4838-9830-9be700de5a20} HTTP/1.1
HOST: rds.bj.baidubce.com
ContentType: application/json
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"
}
],
"tags": [
{
"tagKey": "goods_type",
"tagValue": "music"
}
]
}返回示例
{
"instanceIds":["rds-cwerfq23f"]
}