文档平台 API 中心 云数据库 MySQL 实例相关接口 创建云数据库实例(包年包月)

创建云数据库实例(包年包月)

最近更新时间:2018-10-26 15:05:22

1. 接口描述

接口请求域名: cdb.tencentcloudapi.com 。

本接口(CreateDBInstance)用于创建包年包月的云数据库实例(包括主实例、灾备实例和只读实例),可通过传入实例规格、MySQL 版本号、购买时长和数量等信息创建云数据库实例。

该接口为异步接口,您还可以使用查询实例列表接口查询该实例的详细信息。当该实例的Status为1,且TaskStatus为0,表示实例已经发货成功。

  1. 首先请使用获取云数据库可售卖规格接口查询可创建的实例规格信息,然后请使用查询价格(包年包月)接口查询可创建实例的售卖价格;
  2. 单次创建实例最大支持 100 个,实例时长最大支持 36 个月;
  3. 支持创建 MySQL5.5 、 MySQL5.6 、 MySQL5.7 版本;
  4. 支持创建主实例、只读实例、灾备实例;

默认接口请求频率限制:20次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cdb.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateDBInstance
Version String 公共参数,本接口取值:2017-03-20
Region String 公共参数,详见产品支持的地域列表
Memory Integer 实例内存大小,单位:MB,请使用获取云数据库可售卖规格接口获取可创建的内存规格
Volume Integer 实例硬盘大小,单位:GB,请使用获取云数据库可售卖规格接口获取可创建的硬盘范围
Period Integer 实例时长,单位:月,可选值包括[1,2,3,4,5,6,7,8,9,10,11,12,24,36]
GoodsNum Integer 实例数量,默认值为1, 最小值1,最大值为100
Zone String 可用区信息,该参数缺省时,系统会自动选择一个可用区,请使用获取云数据库可售卖规格接口获取可创建的可用区
UniqVpcId String 私有网络ID,如果不传则默认选择基础网络,请使用查询私有网络列表
UniqSubnetId String 私有网络下的子网ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用查询子网列表
ProjectId Integer 项目ID,不填为默认项目。请使用查询项目列表接口获取项目ID
Port Integer 自定义端口,端口支持范围:[ 1024-65535 ]
InstanceRole String 实例类型,默认为 master,支持值包括:master-表示主实例,dr-表示灾备实例,ro-表示只读实例
MasterInstanceId String 实例ID,购买只读实例时必填,该字段表示只读实例的主实例ID,请使用查询实例列表接口查询云数据库实例ID
EngineVersion String MySQL版本,值包括:5.5、5.6和5.7,请使用获取云数据库可售卖规格接口获取可创建的实例版本
Password String 设置root帐号密码,密码规则:8-64个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义
ProtectMode Integer 数据复制方式,默认为0,支持值包括:0-表示异步复制,1-表示半同步复制,2-表示强同步复制
DeployMode Integer 多可用区域,默认为0,支持值包括:0-表示单可用区,1-表示多可用区
SlaveZone String 备库1的可用区信息,默认为zone的值
ParamList.N Array of ParamInfo 参数列表,参数格式如ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过查询参数列表查询支持设置的参数
BackupZone String 备库2的可用区ID,默认为0,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义
AutoRenewFlag Integer 自动续费标记,可选值为:0-不自动续费;1-自动续费
MasterRegion String 主实例地域信息,购买灾备实例时,该字段必填
SecurityGroup.N Array of String 安全组参数,可使用查询项目安全组信息接口查询某个项目的安全组详情
RoGroup RoGroup 只读实例参数
InstanceName String 实例名称

3. 输出参数

参数名称 类型 描述
DealIds Array of String 短订单ID
InstanceIds Array of String 实例ID列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 购买主实例

输入示例

https://cdb.tencentcloudapi.com/?Action=CreateDBInstance
&Memory=1000
&Volume=25
&Period=1
&GoodsNum=1
&Zone=ap-guangzhou-3
&UniqVpcId=vpc-0akbol5v
&UniqSubnetId=subnet-fyrtjbqw
&ProjectId=0
&InstanceRole=master
&EngineVersion=5.6
&<公共请求参数>

输出示例

{
  "Response": {
    "DealIds": [
      "20171201110011"
    ],
    "InstanceIds": [
      "cdb-pn6gd5jp"
    ],
    "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
  }
}

示例2 购买只读实例

输入示例

https://cdb.tencentcloudapi.com/?Action=CreateDBInstance
&MasterInstanceId=cdb-fn3f9xpx
&Period=1
&GoodsNum=1
&Memory=4000
&Volume=100
&InstanceRole=ro
&RoGroup.roGroupMode=allinone
&RoGroup.roGroupName=jersey_test
&RoGroup.roOfflineDelay=1
&RoGroup.roMaxDelayTime=5
&RoGroup.minRoInGroup=1
&<公共请求参数>

输出示例

{
  "Response": {
    "DealIds": [
      "20171205110051"
    ],
    "InstanceIds": [
      "cdbro-hlpl4ik9"
    ],
    "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
InternalError.DatabaseAccessError 数据库内部错误。
InternalError.DfwError 安全组操作错误。
InternalError.TradeError 交易系统错误。
InternalError.VpcError 私有网络或子网错误。
InvalidParameter 参数错误。
OperationDenied.ActionNotSupport 不支持的操作。
OperationDenied.WrongPassword 密码错误或校验未通过。