创建DCDB分布式实例

最近更新时间:2018-09-28 14:59:57

1. 接口描述

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

本接口(CreateDCDBInstance)用于创建包年包月的云数据库实例,可通过传入实例规格、数据库版本号、购买时长等信息创建云数据库实例。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateDCDBInstance
Version String 公共参数,本接口取值:2018-04-11
Region String 公共参数,详见产品支持的地域列表
Zones.N Array of String 分片节点可用区分布,最多可填两个可用区。当分片规格为一主两从时,其中两个节点在第一个可用区。
Period Integer 欲购买的时长,单位:月。
ShardMemory Integer 分片内存大小,单位:GB,可以通过 DescribeShardSpec
查询实例规格获得。
ShardStorage Integer 分片存储空间大小,单位:GB,可以通过 DescribeShardSpec
查询实例规格获得。
ShardNodeCount Integer 单个分片节点个数,可以通过 DescribeShardSpec
查询实例规格获得。
ShardCount Integer 实例分片个数,可选范围2-8,可以通过升级实例进行新增分片到最多64个分片。
Count Integer 欲购买实例的数量,目前只支持购买1个实例
ProjectId Integer 项目 ID,可以通过查看项目列表获取,不传则关联到默认项目
VpcId String 虚拟私有网络 ID,不传或传空表示创建为基础网络
SubnetId String 虚拟私有网络子网 ID,VpcId不为空时必填
DbVersionId String 数据库引擎版本,当前可选:10.0.10,10.1.9,5.7.17
AutoVoucher Boolean 是否自动使用代金券进行支付,默认不使用。
VoucherIds.N Array of String 代金券ID列表,目前仅支持指定一张代金券。

3. 输出参数

参数名称 类型 描述
DealName String 长订单号。可以据此调用 DescribeOrders
查询订单详细信息,或在支付失败时调用用户账号相关接口进行支付。
InstanceIds Array of String 订单对应的实例 ID 列表,如果此处没有返回实例 ID,可以通过订单查询接口获取。还可通过实例查询接口查询实例是否创建完成。
RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

4. 示例

示例1 创建包年包月的分布式数据库实例

输入示例

https://dcdb.tencentcloudapi.com/?Action=CreateDCDBInstance
&ShardMemory=2
&ShardStorage=10
&ShardNodeCount=3
&ShardCount=2
&DbVersionId=5.7.17
&Count=1
&Period=1
&Zones.0=ap-guangzhou-2
&Zones.1=ap-guangzhou-2
&AutoVoucher=true
&<公共请求参数>

输出示例

{
  "Response": {
    "DealName": "20181103110163",
    "InstanceIds": [
      "dcdbt-avw0207d"
    ],
    "RequestId": "8c4fba95-01e4-61d9-4146-59fc5afdf962"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.CreateOrderFailed 创建订单失败。
FailedOperation.PayFailed 支付订单失败。
InternalError.CamAuthFailed CAM鉴权请求失败。
InternalError.DbOperationFailed 查询数据库失败。
InternalError.GetSubnetFailed 查询虚拟私有网络子网信息失败。
InternalError.GetVpcFailed 查询虚拟私有网络信息失败。
InvalidParameter.GenericParameterError 参数合法性校验错误。
InvalidParameter.SubnetNotFound 找不到指定的虚拟私有网络子网。
InvalidParameter.VpcNotFound 找不到指定的虚拟私有网络。
InvalidParameterValue.IllegalQuantity 商品数量超出限制。
InvalidParameterValue.IllegalZone 找不到指定的可用区。
InvalidParameterValue.SpecIdIllegal 找不到数据库实例对应的规格信息。
UnauthorizedOperation.PermissionDenied 没有权限操作该接口或资源。