创建主实例
更新时间:2026-10-28
创建主实例
前提条件
创建实例需要实名认证,没有通过实名认证的可以前往百度智能云官网控制台中的安全认证下的实名认证中进行认证。
说明
- 本接口用于创建一个或多个相同配置的云数据库 RDS 实例。
- 创建计费方式为后付费的实例需要账户现金余额+通用代金券大于100;预付费方式的实例则需要账户现金余额大于等于实例费用。
- 支持批量创建且如果创建过程中有一个实例创建失败,所有实例将全部回滚,均创建失败。
- 创建接口为异步创建,可通过查询指定实例详情接口查询实例状态。
OpenAPI Explorer
去调试
您可以在 OpenAPI Explorer 中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer 可以自动生成 SDK 代码示例。
请求结构
Plain Text
Plain Text
1POST /v{version}/instance?clientToken={clientToken} HTTP/1.1
2HOST: rds.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "billing":{
7 "paymentTiming": paymentTiming,
8 "reservation": {
9 "reservationLength": reservationLength
10 }
11 },
12 "autoRenewTimeUnit" :autoRenewTimeUnit,
13 "autoRenewTime" :autoRenewTime,
14 "purchaseCount" : purchaseCount,
15 "instanceName" : instanceName,
16 "engine" : engine,
17 "engineVersion" : engineVersion,
18 "characterSetName" : characterSetName,
19 "cpuCount":cpuCount,
20 "memoryCapacity" : memoryCapacity,
21 "volumeCapacity" : volumeCapacity,
22 "diskIoType" : diskIoType,
23 "zoneNames":[zoneName],
24 "vpcId": vpcId ,
25 "isDirectPay": isDirectPay,
26 "replicationType":"replicationType",
27 "ovip" : "ovip",
28 "entryPort" : entryPort,
29 "resourceGroupId" : "resourceGroupId",
30 "initialDataReference":
31 {
32 "instanceId": "instanceId",
33 "referenceType": "referenceType",
34 "datetime": "datetime",
35 "snapshotId": "snapshotId"
36 },
37 "data": [
38 {
39 "dbName" : "dbName",
40 "newDbname" : "newDbname",
41 "restoreMode" : "database"
42 },
43 {
44 "dbname" : "dbname",
45 "newDbname" : "newDbname",
46 "restoreMode" : "table",
47 "tables" : [
48 {
49 "tableName" : "tableName",
50 "newTablename" : "newTablename"
51 }
52 ]
53 }
54 ],
55 "subnets" : [
56 {
57 "zoneName" : zoneName,
58 "subnetId" : subnetId
59 }
60 ],
61 "tags": [
62 {
63 "tagKey" : tagKey,
64 "tagValue" : tagValue
65 }
66 ]
67}
请求头域
除公共头域外,无其它特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | Integer | 是 | URL参数 | API 版本号 |
| clientToken | String | 是 | Query参数 | 幂等性Token,是一个长度不超过64位的ASCII字符串 |
| billing | Billing | 是 | RequestBody参数 | 计费相关参数。结构及取值参考 |
| purchaseCount | Integer | 否 | RequestBody参数 | 批量创建云数据库 RDS 实例个数, 最大不超过10;默认1 |
| instanceName | String | 否 | RequestBody参数 | 1)用户自定义实例名; 2)允许小写字母、数字; 3)长度限制为1~64; 4) 默认命名规则:{engine} + {engineVersion} |
| engine | String | 是 | RequestBody参数 | 数据库引擎: MySQL 、SQLServer 、PostgreSQL。详情参考 |
| engineVersion | String | 是 | RequestBody参数 | 数据库版本: MySQL:5.5/5.6/5.7/8.0 SQLServer:2008r2/2012sp3/2016sp1/2017sp1 PostgreSQL:10/11/12/13/14 |
| category | String | 否 | RequestBody参数 | 所属系列: Singleton:单机基础版、Standard:双机高可用版。 默认Standard。详情参考 |
| cpuCount | Integer | 是 | RequestBody参数 | CPU核数。取值参考 |
| memoryCapacity | Integer | 是 | RequestBody参数 | 套餐内存大小,单位GB。取值参考 |
| volumeCapacity | Integer | 是 | RequestBody参数 | 套餐磁盘大小,单位GB,每5G递增。范围参考 |
| diskIoType | String | 是 | RequestBody参数 | 磁盘类型: normal_io : 本地盘ssd磁盘 cloud_high : 高性能云磁盘 cloud_nor : 通用型SSD cloud_enha: 增强型SSD |
| zoneNames | List<String> | 否 | RequestBody参数 | 指定zone信息,默认为空,由系统自动选择,可通过调用查询可用区列表接口查询可用区列表。zoneName命名规范是小写的“国家-region-可用区序列",例如北京可用区A为"cn-bj-a"。 |
| bcmGroupName | String | 否 | RequestBody参数 | 默认为空,代表bcm实例组名称 |
| vpcId | String | 是 | RequestBody参数 | vpc,如果不提供则属于默认vpc。可通过调用 查询VPC列表接口查询可用的VPC |
| isDirectPay | Boolean | 否 | RequestBody参数 | 是否进行直接支付,默认false,设置为直接支付的变配订单会直接扣款,不需要在走支付逻辑 |
| subnets | List<SubnetMap> | 否 | RequestBody参数 | vpc内,每个可用区的subnetId;如果不是默认vpc则必须指定 subnetId。创建集群版时如果主备所属可用区子网一致,此处数组只需传一项;可通过调用查询子网列表接口查询子网列表。 |
| tags | List<Tag> | 否 | RequestBody参数 | 实例绑定的标签信息 |
| bgwGroupId | String | 否 | RequestBody参数 | 如果bgwGroupExclusive为true,若创建实例时指定了专属集群ID,则将blb分配到指定的专属集群,如果不传按照默认情况 |
| bgwGroupExclusive | Boolean | 否 | RequestBody参数 | 负载均衡集群属性,true表示指定专属集群,false表示使用共享集群 |
| characterSetName | String | 否 | RequestBody参数 | 指定实例字符集,有"utf8mb4","latin1","gbk","utf8"可选,默认为"utf8"(目前只支持mysql主实例) |
| autoRenewTimeUnit | String | 否 | RequestBody参数 | 自动续费单位("year";"month") |
| autoRenewTime | Integer | 否 | RequestBody参数 | 自动续费时长(续费单位为year 不大于3,续费单位为month 不大于9) |
| lowerCaseTableNames | Integer | 否 | RequestBody参数 | 表名是否区分大小写。默认为0,表示大小写敏感,区分大小写;传1表示不区分大小写 |
| parameterTemplateId | String | 否 | RequestBody参数 | 参数模板ID |
| ovip | String | 否 | RequestBody参数 | RDS实例访问入口BLB的ovip,传该参数且值非空,会根据该值为blb的ovip去申请blb,否则申请blb随机分配ip |
| entryPort | Integer | 否 | RequestBody参数 | RDS实例访问入口BLB的端口,传该参数且值非空,会根据该值为blb的listener port去申请blb,否则默认3306,端口取值范围:1024-65535 |
| replicationType | String | 否 | RequestBody参数 | 数据复制方式。异步复制:async,半同步复制:semi_sync |
| resourceGroupId | String | 否 | RequestBody参数 | 资源分组ID。例如:RESG-bKMxbExtnoG |
| initialDataReference | InitialDataReference | 否 | RequestBody参数 | 克隆实例的参数 |
| data | List |
否 | RequestBody参数 | 库表恢复到新实例,恢复的库表信息 |
| leaderInstanceId | String | 否 | RequestBody参数 | MySQL主角色ID,传入实例的MySQL大版本需要和当前创建参数里的MySQL大版本保持一致,指定了这个参数后新建实例的MySQL小版本会和指定实例的MySQL小版本保持一致 |
| resourceType | String | 否 | RequestBody参数 | 实例类型,支持exclusive/shared,默认exclusive。exclusive表示独享型,shared表示通用型 |
Billing字段数据结构说明
| 参数名称 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| paymentTiming | String | 是 | 付费方式。预付费:Prepaid,后付费:Postpaid |
| reservation | Reservation | 否 | 保留信息,支付方式为后付费时不需要设置,预付费时必须设置 |
Reservation字段数据结构说明
| 参数名称 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| reservationLength | Integer | 是 | 时长,取值 [1,2,3,4,5,6,7,8,9,12,24,36] |
| reservationTimeUnit | String | 否 | 时间单位,Month,当前仅支持按月 |
SubnetMap字段数据结构说明
| 参数名称 | 类型 | 描述 |
|---|---|---|
| zoneName | String | 可用区 |
| subnetId | String | 子网 ID |
Tag字段数据结构说明
| 参数名称 | 类型 | 描述 |
|---|---|---|
| tagKey | String | 标签 key |
| tagValue | String | 标签 value |
InitialDataReference字段数据结构说明
| 参数名称 | 类型 | 描述 |
|---|---|---|
| instanceId | String | 数据源的InstanceId |
| referenceType | String | 仅限两种取值:datetime, snapshot |
| datetime | String | 库表恢复到新实例,恢复的目标时间点 referenceType为datetime时,必须,初始数据导入的目标时间,标准时间格式,中国+8时区 |
| snapshotId | String | referenceType为snapshot时必须,初始数据导入的目标备份集,取备份集ID |
RecoveryToSourceInstanceModel字段数据结构说明
| 参数名称 | 类型 | 描述 | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| restoreMode | String | 表示恢复模式,支持database和table两种 | ||||||||||||||||||
| dbName | String | 要恢复库的名称 | ||||||||||||||||||
| newDbname | String | 表示恢复后库的名称 | ||||||||||||||||||
| tables | List
Table字段数据结构说明
返回头域 除公共头域,无其它特殊头域。 返回参数
请求示例 Plain Text
Plain Text
返回示例 Plain Text
Plain Text
评价此篇文章 |
