1. 接口描述
接口请求域名： dcdb.tencentcloudapi.com 。
本接口（CreateDCDBInstance）用于创建包年包月的TDSQL实例，可通过传入实例规格、数据库版本号、购买时长等信息创建云数据库实例。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateDCDBInstance。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-11。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Zones.N | 是 | Array of String | 分片节点可用区分布，可填写多个可用区。 注意当前可售卖的可用区需要通过DescribeDCDBSaleInfo接口拉取。 示例值：["ap-guangzhou-2","ap-guangzhou-2"] |
| Period | 是 | Integer | 欲购买的时长，单位：月。 示例值：1 |
| ShardMemory | 是 | Integer | 分片内存大小，单位：GB，可以通过 DescribeShardSpec 查询实例规格获得。 示例值：2 |
| ShardStorage | 是 | Integer | 分片存储空间大小，单位：GB，可以通过 DescribeShardSpec 查询实例规格获得。 示例值：10 |
| ShardNodeCount | 是 | Integer | 单个分片节点个数，可以通过 DescribeShardSpec 查询实例规格获得。 示例值：3 |
| ShardCount | 是 | Integer | 实例分片个数，可选范围2-8，可以通过升级实例进行新增分片到最多64个分片。 示例值：2 |
| Count | 否 | Integer | 欲购买实例的数量 示例值：1 |
| ProjectId | 否 | Integer | 项目 ID，可以通过查看项目列表获取，不传则关联到默认项目 |
| VpcId | 否 | String | 虚拟私有网络 ID，不传或传空表示创建为基础网络 |
| SubnetId | 否 | String | 虚拟私有网络子网 ID，VpcId不为空时必填 |
| DbVersionId | 否 | String | 数据库引擎版本，当前可选：8.0，5.7，10.1，10.0。 示例值：5.7 |
| AutoVoucher | 否 | Boolean | 是否自动使用代金券进行支付，默认不使用。 示例值：true |
| VoucherIds.N | 否 | Array of String | 代金券ID列表，目前仅支持指定一张代金券。 |
| SecurityGroupId | 否 | String | 安全组id |
| InstanceName | 否 | String | 实例名称， 可以通过该字段自主的设置实例的名字 |
| Ipv6Flag | 否 | Integer | 是否支持IPv6，0:不支持，1:支持 |
| ResourceTags.N | 否 | Array of ResourceTag | 标签键值对数组 |
| InitParams.N | 否 | Array of DBParamValue | 参数列表。本接口的可选值为：character_set_server（字符集，必传），lower_case_table_names（表名大小写敏感，必传，0 - 敏感；1-不敏感），innodb_page_size（innodb数据页，默认16K），sync_mode（同步模式：0 - 异步； 1 - 强同步；2 - 强同步可退化。默认为强同步可退化）。 |
| DcnRegion | 否 | String | DCN源地域 |
| DcnInstanceId | 否 | String | DCN源实例ID |
| AutoRenewFlag | 否 | Integer | 自动续费标记，0:默认状态(用户未设置，即初始状态即手动续费，用户开通了预付费不停服特权也会进行自动续费)， 1:自动续费，2:明确不自动续费(用户设置)。若业务无续费概念或无需自动续费，需要设置为0 示例值：0 |
| SecurityGroupIds.N | 否 | Array of String | 安全组ids，安全组可以传数组形式，兼容之前SecurityGroupId参数 |
| DcnSyncMode | 否 | Integer | DCN同步模式，0：异步， 1：强同步 示例值：1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DealName | String | 长订单号。可以据此调用 DescribeOrders 查询订单详细信息，或在支付失败时调用用户账号相关接口进行支付。 示例值：20181103110163 |
| InstanceIds | Array of String | 订单对应的实例 ID 列表，如果此处没有返回实例 ID，可以通过订单查询接口获取。还可通过实例查询接口查询实例是否创建完成。 注意：此字段可能返回 null，表示取不到有效值。 示例值：["dcdbt-avw0207d"] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建TDSQL包年包月实例
创建TDSQL包年包月实例
输入示例
POST / HTTP/1.1
Host: dcdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDCDBInstance
<公共请求参数>
{
"Count": "1",
"DbVersionId": "5.7.17",
"ShardNodeCount": "3",
"Period": "1",
"AutoVoucher": "true",
"Zones": [
"ap-guangzhou-2",
"ap-guangzhou-2"
],
"ShardMemory": "2",
"ShardCount": "2",
"ShardStorage": "10"
}输出示例
{
"Response": {
"RequestId": "8c4fba95-01e4-61d9-4146-59fc5afdf962",
"DealName": "20181103110163",
"InstanceIds": [
"dcdbt-avw0207d"
]
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.CreateOrderFailed | 创建订单失败。 |
| FailedOperation.PayFailed | 支付订单失败。 |
| FailedOperation.TagDryRunError | 标签键值校验或鉴权失败。 |
| InternalError.CamAuthFailed | CAM鉴权请求失败。 |
| InternalError.CheckVipStatusFailed | 校验VIP状态失败。 |
| InternalError.DbOperationFailed | 查询数据库失败。 |
| InternalError.GetSubnetFailed | 查询虚拟私有网络子网信息失败。 |
| InternalError.GetVpcFailed | 查询虚拟私有网络信息失败。 |
| InternalError.OperateDatabaseFailed | 数据库操作失败。 |
| InvalidParameter.CheckParamNotPass | 入参校验失败。 |
| InvalidParameter.GenericParameterError | 参数合法性校验错误。 |
| InvalidParameter.SpecNotFound | 找不到对应的售卖规格。 |
| InvalidParameter.SubnetNotFound | 找不到指定的虚拟私有网络子网。 |
| InvalidParameter.VpcNotFound | 找不到指定的虚拟私有网络。 |
| InvalidParameterValue.IllegalQuantity | 商品数量超出限制。 |
| InvalidParameterValue.IllegalZone | 找不到指定的可用区。 |
| InvalidParameterValue.SpecIdIllegal | 找不到数据库实例对应的规格信息。 |
| UnauthorizedOperation.PermissionDenied | 没有权限操作该接口或资源。 |
| UnsupportedOperation.DbVersionNotSupported | 不支持该数据库版本。 |
