1. 接口描述
接口请求域名： dcdb.api3.fincloud.tencent.com。
创建后付费实例
默认接口请求频率限制：20次/秒。
接口更新时间：2025-05-10 14:49:04。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CreateHourDCDBInstance |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-04-11 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| VpcId | 是 | 否 | String | 虚拟私有网络 ID 示例值： 0 |
| SubnetId | 是 | 否 | String | 虚拟私有网络子网 ID 示例值： 0 |
| ShardMemory | 是 | 否 | Int64 | 分片内存大小，单位：GB，可以通过 DescribeShardSpec 查询实例规格获得。 示例值： 2 |
| ShardStorage | 是 | 否 | Int64 | 分片存储空间大小，单位：GB，可以通过 DescribeShardSpec 查询实例规格获得。 示例值： 10 |
| ShardNodeCount | 是 | 否 | Int64 | 单个分片节点个数，可以通过 DescribeShardSpec 查询实例规格获得。 示例值： 2 |
| ShardCount | 是 | 否 | Int64 | 实例分片个数，可选范围2-8，可以通过升级实例进行新增分片到最多64个分片。 示例值： 2 |
| DbVersionId | 否 | 否 | String | 数据库引擎版本，调用 DescribeDBEngines 查询可用的版本。 示例值： 5.7 |
| Zones | 是 | 否 | Array of String | 分片节点可用区分布，最多可填两个可用区。当分片规格为一主两从时，其中两个节点在第一个可用区。 示例值： ["ap-region1-1"] |
| Count | 否 | 否 | Int64 | 欲购买实例的数量 示例值： 1 |
| ShardCpu | 否 | 否 | Int64 | 分片cpu大小，单位：核，可以通过 DescribeShardSpec 查询实例规格获得。 示例值： 0 |
| SecurityGroupId | 否 | 否 | String | 安全组id 示例值： sg-12345 |
| InstanceName | 否 | 否 | String | 实例名称， 可以通过该字段自主的设置实例的名字 示例值： 实例名称 |
| ExclusterId | 否 | 否 | String | 资源池 Id，内部专用 示例值： Resource_pool1 |
| Ipv6Flag | 否 | 否 | Int64 | 是否支持IPv6，0-不支持，1-支持 示例值： 0 |
| ResourceTags | 否 | 否 | Array of ResourceTag | 标签键值对数组 示例值：查看 |
| DcnRegion | 否 | 否 | String | DCN源地域 示例值： ap-region1 |
| DcnInstanceId | 否 | 否 | String | DCN源实例ID 示例值： tdsqlshard-cq3ndzu7 |
| PlatformProjectId | 否 | 否 | String | 平台项目ID 示例值： pr-3f3e2f46 |
| CpuArch | 否 | 否 | String | cpu架构 示例值： x86 |
| InitParams | 否 | 否 | Array of DBParamValue | 参数列表。本接口的可选值为：character_set_server（字符集，必传），lower_case_table_names（表名大小写敏感，必传，0 - 敏感；1-不敏感），innodb_page_size（innodb数据页，默认16K），sync_mode（同步模式：0 - 异步； 1 - 强同步；2 - 强同步可退化。默认为强同步可退化）。 示例值：查看 |
| RsAccessStrategy | 否 | 否 | Int64 | RS访问策略, 0-无策略, 1-可用区就近访问 示例值： 0 |
| RollbackInstanceId | 否 | 否 | String | 需要回档的源实例ID 示例值： tdsqlshard-mfktr7ji |
| RollbackTime | 否 | 否 | String | 回档时间，例如“2021-11-22 00:00:00” 示例值： 2024-11-13 18:10:22 |
| DcnSyncMode | 否 | 否 | Int64 | DCN同步模式，0：异步， 1：强同步 示例值： 1 |
| TemplateId | 否 | 否 | Int64 | 参数模板id 示例值： 1 |
| NumaAffinity | 否 | 否 | Int64 | numa参数,1为no-numa,2为single-numa 示例值： 1 |
| SecurityGroupIds | 否 | 否 | Array of String | 要修改的安全组ID列表，一个或者多个安全组Id组成的数组。 示例值： [ "sg-n6d4pbgn", "sg-9bkko8g9", "sg-5e9k81pj" ] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| InstanceIds | Array of String | 订单对应的实例 ID 列表，如果此处没有返回实例 ID，可以通过订单查询接口获取。还可通过实例查询接口查询实例是否创建完成。 示例值： ["tdsqlshard-cq3ndzu7"] |
| FlowId | Int64 | 流程id，可以根据流程id查询创建进度 示例值： 1122 |
| DealName | String | 长订单号 示例值： 20250509110283 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.CreateOrderFailed | 创建订单失败。 |
| FailedOperation.TagDryRunError | 标签键值校验或鉴权失败。 |
| FailedOperation.UserNotAuthed | 用户未实名认证。 |
| InternalError.DbOperationFailed | 查询数据库失败。 |
| InternalError.GetSubnetFailed | 查询虚拟私有网络子网信息失败。 |
| InternalError.GetVpcFailed | 查询虚拟私有网络信息失败。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.SpecNotFound | 找不到对应的售卖规格。 |
| InvalidParameter.SubnetNotFound | 找不到指定的虚拟私有网络子网。 |
| InvalidParameterValue.IllegalCount | 购买实例数量超出限制或者购买实例分片数量超出限制（最多64个分片）。 |
| InvalidParameterValue.IllegalNodeCount | 每个分片节点个数参数有误。 |
| InvalidParameterValue.IllegalZone | 找不到指定的可用区。 |
| InvalidParameterValue.SpecIdIllegal | 找不到数据库实例对应的规格信息。 |
| InvalidParameter.VpcNotFound | 找不到指定的虚拟私有网络。 |
| UnauthorizedOperation.PermissionDenied | 没有权限操作该接口或资源。 |
| ResourcesSoldOut | 资源售罄。 |