创建主实例

更新时间：2024-09-23

前提条件

创建实例需要实名认证，没有通过实名认证的可以前往百度智能云官网控制台中的安全认证下的实名认证中进行认证。

说明

本接口用于创建一个或多个相同配置的云数据库 RDS 实例。
创建计费方式为后付费的实例需要账户现金余额+通用代金券大于100；预付费方式的实例则需要账户现金余额大于等于实例费用。
支持批量创建且如果创建过程中有一个实例创建失败，所有实例将全部回滚，均创建失败。
创建接口为异步创建，可通过查询指定实例详情接口查询实例状态。

请求结构

POST /v{version}/instance?clientToken={clientToken} HTTP/1.1
HOST: rds.bj.baidubce.com
Authorization: authorization string

{
    "billing":{
        "paymentTiming": paymentTiming,
        "reservation": {
            "reservationLength": reservationLength
        }
    },
    "autoRenewTimeUnit"         :autoRenewTimeUnit,
    "autoRenewTime"             :autoRenewTime,
    "purchaseCount"             : purchaseCount,
    "instanceName"              : instanceName,
    "engine"                    : engine,
    "engineVersion"             : engineVersion,
    "characterSetName"          : characterSetName,
    "cpuCount":cpuCount,
    "memoryCapacity"       : memoryCapacity,
    "volumeCapacity"       : volumeCapacity,
    "diskIoType"       : diskIoType,
    "zoneNames":[zoneName],
    "vpcId": vpcId ,
    "isDirectPay": isDirectPay,
    "replicationType":"replicationType",
    "ovip" : "ovip",
    "entryPort" : entryPort,
    "resourceGroupId" : "resourceGroupId",
    "initialDataReference": 
    {
        "instanceId": "instanceId",
        "referenceType": "referenceType",
        "datetime": "datetime",
        "snapshotId": "snapshotId"
    },
    "data": [
        {
            "dbName" : "dbName",
            "newDbname" : "newDbname",
            "restoreMode" : "database"
        },
        {
            "dbname" : "dbname",
            "newDbname" : "newDbname",
            "restoreMode" : "table",
            "tables" : [
                {
                    "tableName" : "tableName",
                    "newTablename" : "newTablename"
                }
            ]
        }
    ],
    "subnets" : [
    {
    	"zoneName" : zoneName,
    	"subnetId" : subnetId
    }
    ],
     "tags": [
        {
            "tagKey" : tagKey,
            "tagValue" : tagValue
        }
    ]
}

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必选	参数位置	描述
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<RecoveryToSourceInstanceModel>	否	RequestBody参数	库表恢复到新实例，恢复的库表信息
leaderInstanceId	String	否	RequestBody参数	MySQL主角色ID，传入实例的MySQL大版本需要和当前创建参数里的MySQL大版本保持一致，指定了这个参数后新建实例的MySQL小版本会和指定实例的MySQL小版本保持一致
resourceType	String	否	RequestBody参数	实例类型，支持exclusive/shared，默认exclusive。exclusive表示独享型，shared表示通用型

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>	表示恢复后库的名称

Table字段数据结构说明

参数名称	类型	描述
tableName	String	需要恢复的表名
newTablename	String	恢复后表名

返回头域

除公共头域，无其它特殊头域。

返回参数

参数名称	类型	描述
instanceIds	List<String>	由InstanceId组成的数组
orderId	String	订单 ID

请求示例

POST /v1/instance?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST: rds.bj.baidubce.com
Content-Type: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
	"billing":{
	   "paymentTiming":"Prepaid",
	   "reservation": {
	       "reservationLength": 1
	   }
	},
    "autoRenewTimeUnit":"year",
    "autoRenewTime":1,
	"purchaseCount":1,
	"instanceName":"rds-01",
	"engine":"mysql",
	"engineVersion":"5.6",
    "characterSetName": "utf8mb4",
	"cpuCount":1,
	"memoryCapacity":2,
	"volumeCapacity":5,
    "diskIoType":"normal_io",
	"zoneNames":["cn-bj-d"],
    "vpcId": "vpc-70pxg3pmv8rv",
    "isDirectPay": false,
    "subnets":[
    {
    "zoneName": "cn-bj-d",
    "subnetId": "sbn-dqafncqsy3y4"
    }
    ],
    "tags": [
        {
            "tagKey": "goods_type",
            "tagValue": "music"
        }
    ]
}

返回示例

{
    "instanceIds":["rds-sgrw14145"],
    "orderId": "xxxxxxxxxxxxxxxxx"
}

SampleCode

实例开启自动续费

云数据库 RDS

创建主实例