创建实例(包年包月)

最近更新时间:2017-10-27 11:30:04

1. 接口描述

本接口(CreateCdb)用于创建包年包月的实例(包括主实例和只读实例),可通过传入实例规格、MySQL 版本号、购买时长和数量等信息创建云数据库实例。
您还可以使用查询实例列表接口查询该实例的详细信息。
接口请求域名:cdb.api.qcloud.com

  1. 首先请使用查询可创建规格(支持可用区、配置自定义)接口查询可创建的实例规格信息,然后请使用查询价格(包年包月)接口查询可创建实例的售卖价格;
  2. 单次创建实例最大支持 10 个,实例时长最大支持 36 个月;
  3. 支持创建 MySQL5.5 和 MySQL5.6 版本;
  4. 支持创建主实例、只读实例,暂不支持创建灾备实例,您可使用创建实例(按量计费)接口创建灾备实例;

2. 输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见公共请求参数页面。其中,此接口的Action字段为CreateCdb。

参数名称 必选 类型 描述
cdbType String 实例规格,支持固定规格和自定义规格。传 CUSTOM 代表自定义规格; 固定规格的取值,请使用查询可创建规格接口获取。 固定规格类型将会下线,推荐使用自定义规格。
engineVersion String MySQL版本,值包括:5.5和5.6,请使用查询可创建规格(支持可用区、配置自定义)接口获取可创建的实例版本
period Int 实例时长,单位:月,最小值1,最大值为36,请使用查询可创建规格(支持可用区、配置自定义)接口获取可创建的实例时长,该接口返回字段timeSpan表示时长可选值
goodsNum Int 实例数量,默认值为1, 最小值1,最大值为10,请使用查询可创建规格(支持可用区、配置自定义)接口获取可创建的实例数量
vpcId String 私有网络ID,格式为 gz_vpc_64 或者 64,如果不传则默认选择基础网络,请使用查询私有网络列表
subnetId String 私有网络下的子网ID,格式为 gz_subnet_18748 或者 18748,如果设置了 vpcId,则 subnetId 必填,请使用查询子网列表
projectId Int 项目ID,不填为默认项目。请使用查询项目列表接口获取项目ID
memory Int 实例内存大小,单位:MB,当 cdbType 值为 CUSTOM 时, memory 为必填;当 cdbType 为整型值时,传入 memory 值将无效,请使用查询可创建规格(支持可用区、配置自定义)接口获取可创建的内存规格
volume Int 实例硬盘大小,单位:GB,当 cdbType 值为 CUSTOM 时, volume 为必填;当 cdbType 为整型值时,传入 volume 值将无效,请使用查询可创建规格(支持可用区、配置自定义)接口获取可创建的硬盘范围
zoneId Int 可用区ID,该参数缺省时,系统会自动选择一个可用区,请使用查询可创建规格(支持可用区、配置自定义)接口获取可创建的可用区
port Int 自定义端口,端口支持范围:[ 1024-65535 ]
password String 设置root帐号密码,密码规则:8-16个字符,至少包含字母、数字、字符(支持的字符:!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义
instanceRole String 实例类型,默认为 master,支持值包括:master-表示主实例,ro-表示只读实例
cdbInstanceId String 实例ID,购买只读实例时必填,该字段表示只读实例的主实例ID,请使用查询实例列表接口查询云数据库实例ID
protectMode Int 数据复制方式,默认为0,支持值包括:0-表示异步复制,1-表示半同步复制,2-表示强同步复制
deployMode Int 多可用区域,默认为0,支持值包括:0-表示单可用区,1-表示多可用区
slaveZoneFirst Int 备库1的可用区ID,默认为zoneId的值
slaveZoneSecond Int 备库2的可用区ID,默认为0

其中paramList为修改实例的参数列表,是一个数组,其中每一个元素包含name和value字段,格式描述如下(购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义):

参数名称 是否必选 类型 描述
paramList.n.name String 待修改参数的名
paramList.n.value String 待修改参数的值

3. 输出参数

参数名称 类型 描述
code Int 公共错误码, 0表示成功,其他值表示失败。详见错误码页面的公共错误码
message String 模块错误信息描述,与接口相关。
codeDesc String 英文错误描述
dealIds Array 短订单ID,用于调用云API相关接口,如获取订单信息

其中, data 参数的构成如下:

参数名称 类型 描述
dealIds Array 短订单ID,用于调用云API相关接口,如获取订单信息
dealNames Array 长订单ID,用于反馈订单问题给腾讯云官方客服
cdbInstanceIds Object 实例ID列表,以长订单ID为键,实例ID为值(Array)

4. 错误码表

以下错误码表列出了该接口的业务逻辑错误码。

错误代码 英文提示 错误描述
100207 OperationConstraints.AccountBalanceNotEnough 帐户余额不足
9301 InvalidParameter 交易参数错误。实际调用的时候,会返回具体的错误信息
9006 InternalError 数据库内部错误
9003 InvalidParameter 参数错误。实际调用的时候,会返回具体的错误信息

5. 示例

输入

https://cdb.api.qcloud.com/v2/index.php?Action=CreateCdb
&<公共请求参数>
&engineVersion=5.6
&cdbType=custom
&goodsNum=1
&memory=360
&volume=10
&zoneId=100002
&period=1
&paramList.0.name=connect_timeout
&paramList.0.value=11

输出

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "dealIds": [
        "2722497"
    ],
    "data": {
        "dealNames": [
            "20161123119511"
        ],
        "dealIds": [
            "2722497"
        ],
        "cdbInstanceIds": {
            "20161123119511": [
                "cdb-dgnbhovw"
            ]
        }
    }
}