1. 接口描述
接口请求域名： cynosdb.tencentcloudapi.com 。
购买新集群
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateClusters。 |
| Version | 是 | String | 公共参数，本接口取值：2019-01-07。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-nanjing, ap-seoul, ap-shanghai, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley 。 |
| Zone | 是 | String | 可用区 示例值：ap-guangzhou-3 |
| VpcId | 是 | String | 所属VPC网络ID 示例值：vpc-1ptuei0b |
| SubnetId | 是 | String | 所属子网ID 示例值：subnet-1tmw9t4o |
| DbType | 是 | String | 数据库类型，取值范围: 示例值：MYSQL |
| DbVersion | 是 | String | 数据库版本，取值范围: 示例值：5.7 |
| ProjectId | 否 | Integer | 所属项目ID 示例值：0 |
| Cpu | 否 | Integer | 当DbMode为NORMAL或不填时必选 普通实例Cpu核数 示例值：1 |
| Memory | 否 | Integer | 当DbMode为NORMAL或不填时必选 普通实例内存,单位GB 示例值：4 |
| Storage | 否 | Integer | 该参数无实际意义，已废弃。 存储大小，单位GB。 示例值：100 |
| ClusterName | 否 | String | 集群名称，长度小于64个字符，每个字符取值范围：大/小写字母，数字，特殊符号（'-','_','.'） 示例值：MyClusterName |
| AdminPassword | 否 | String | 账号密码(8-64个字符，包含大小写英文字母、数字和符号~!@#$%^&*_-+=`|(){}[]:;'<>,.?/中的任意三种) 示例值：passwd@admin |
| Port | 否 | Integer | 端口，默认3306，取值范围[0, 65535) 示例值：3306 |
| PayMode | 否 | Integer | 计费模式，按量计费：0，包年包月：1。默认按量计费。 示例值：0 |
| Count | 否 | Integer | 购买集群数，可选值范围[1,50]，默认为1 示例值：1 |
| RollbackStrategy | 否 | String | 回档类型： noneRollback：不回档； snapRollback，快照回档； timeRollback，时间点回档 示例值：noneRollback |
| RollbackId | 否 | Integer | 快照回档，表示snapshotId；时间点回档，表示queryId，为0，表示需要判断时间点是否有效 示例值：0 |
| OriginalClusterId | 否 | String | 回档时，传入源集群ID，用于查找源poolId 示例值：cynosdbmysql-xxxxxxxx |
| ExpectTime | 否 | String | 时间点回档，指定时间；快照回档，快照时间 示例值：2021-04-26 18:13:10 |
| ExpectTimeThresh | 否 | Integer | 该参数无实际意义，已废弃。 时间点回档，指定时间允许范围 示例值：0 |
| StorageLimit | 否 | Integer | 普通实例存储上限，单位GB 当DbType为MYSQL，且存储计费模式为预付费时，该参数需不大于cpu与memory对应存储规格上限 示例值：100 |
| InstanceCount | 否 | Integer | 实例数量，数量范围为(0,16] 示例值：1 |
| TimeSpan | 否 | Integer | 包年包月购买时长 示例值：1 |
| TimeUnit | 否 | String | 包年包月购买时长单位，['s','d','m','y'] 示例值：m |
| AutoRenewFlag | 否 | Integer | 包年包月购买是否自动续费，默认为0。 0标识默认续费方式，1表示自动续费，2表示手不自动续费。 示例值：0 |
| AutoVoucher | 否 | Integer | 是否自动选择代金券 1是 0否 默认为0 示例值：0 |
| HaCount | 否 | Integer | 实例数量（该参数已不再使用，只做存量兼容处理） 示例值：1 |
| OrderSource | 否 | String | 订单来源 示例值：MyOrderSource |
| ResourceTags.N | 否 | Array of Tag | 集群创建需要绑定的tag数组信息 |
| DbMode | 否 | String | Db类型 当DbType为MYSQL时可选(默认NORMAL)： 示例值：NORMAL |
| MinCpu | 否 | Float | 当DbMode为SERVERLESS时必填 cpu最小值，可选范围参考DescribeServerlessInstanceSpecs接口返回 示例值：1.0 |
| MaxCpu | 否 | Float | 当DbMode为SERVERLESS时必填： cpu最大值，可选范围参考DescribeServerlessInstanceSpecs接口返回 示例值：2.0 |
| AutoPause | 否 | String | 当DbMode为SERVERLESS时，指定集群是否自动暂停，可选范围 默认值:yes 示例值：yes |
| AutoPauseDelay | 否 | Integer | 当DbMode为SERVERLESS时，指定集群自动暂停的延迟，单位秒，可选范围[600,691200] 默认值:600 示例值：600 |
| StoragePayMode | 否 | Integer | 集群存储计费模式，按量计费：0，包年包月：1。默认按量计费 当DbType为MYSQL时，在集群计算计费模式为后付费（包括DbMode为SERVERLESS）时，存储计费模式仅可为按量计费 回档与克隆均不支持包年包月存储 示例值：0 |
| SecurityGroupIds.N | 否 | Array of String | 安全组id数组 |
| AlarmPolicyIds.N | 否 | Array of String | 告警策略Id数组 |
| ClusterParams.N | 否 | Array of ParamItem | 参数数组，暂时支持character_set_server （utf8｜latin1｜gbk｜utf8mb4） ，lower_case_table_names，1-大小写不敏感，0-大小写敏感 |
| DealMode | 否 | Integer | 交易模式，0-下单且支付，1-下单 示例值：0 |
| ParamTemplateId | 否 | Integer | 参数模板ID，可以通过查询参数模板信息DescribeParamTemplates获得参数模板ID 示例值：0 |
| SlaveZone | 否 | String | 多可用区地址 示例值：ap-guangzhou-2 |
| InstanceInitInfos.N | 否 | Array of InstanceInitInfo | 实例初始化配置信息，主要用于购买集群时选不同规格实例 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TranId | String | 冻结流水ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：20190522160000003106844584180998 |
| DealNames | Array of String | 订单号 注意：此字段可能返回 null，表示取不到有效值。 示例值：["20190522112283"] |
| ResourceIds | Array of String | 资源ID列表（该字段已不再维护，请使用dealNames字段查询接口DescribeResourcesByDealName获取资源ID） 注意：此字段可能返回 null，表示取不到有效值。 示例值：["cynosdbpg-ins-67rmucgk"] |
| ClusterIds | Array of String | 集群ID列表（该字段已不再维护，请使用dealNames字段查询接口DescribeResourcesByDealName获取集群ID） 注意：此字段可能返回 null，表示取不到有效值。 示例值：["cynosdbmysql-sls-9nts65r2"] |
| BigDealIds | Array of String | 大订单号 注意：此字段可能返回 null，表示取不到有效值。 示例值：["xxx"] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 购买新集群
购买新集群
输入示例
POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateClusters
<公共请求参数>
{
"Count": "1",
"StoragePayMode": "0",
"VpcId": "vpc-1ptuei0b",
"Zone": "ap-guangzhou-3",
"AdminPassword": "passwd@admin",
"DbType": "MYSQL",
"ProjectId": "0",
"DbVersion": "10.0",
"Storage": "100",
"PayMode": "0",
"ClusterName": "newInstance",
"StorageLimit": "100",
"RollbackStrategy": "noneRollback",
"Memory": "4",
"SubnetId": "subnet-1tmw9t4o",
"Cpu": "2",
"HaCount": "1"
}输出示例
{
"Response": {
"ResourceIds": [
"cynosdbmysql-ins-67rmucgk"
],
"RequestId": "132075",
"TranId": "20190522160000003106844584180998",
"ClusterIds": [
"cynosdbmysql-sls-9nts65r2"
],
"BigDealIds": [
"xxx"
],
"DealNames": [
"20190522112283"
]
}
}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.CreateOrder | 创建并支付订单失败。 |
| FailedOperation.InsufficientBalance | 账号余额不足。 |
| FailedOperation.OperationFailedError | 操作失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| FailedOperation.QuerySpecBySpecCodeError | 规格信息查询失败。 |
| FailedOperation.TradeCreateOrderError | 创建并支付订单失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| InternalError.DbOperationFailed | 查询数据库失败。 |
| InternalError.GetSubnetFailed | 获取子网失败。 |
| InternalError.GetVpcFailed | 获取VPC失败。 |
| InternalError.InternalHttpServerError | http请求执行异常。 |
| InternalError.UnknownError | 未知的内部错误。 |
| InvalidParameterValue.DBTypeNotFound | 不支持的实例类型。 |
| InvalidParameterValue.IllegalPassword | 密码不符合要求。 |
| InvalidParameterValue.InvalidDBVersion | 实例版本非法。 |
| InvalidParameterValue.InvalidParameterValueError | 参数值无效。 |
| InvalidParameterValue.InvalidSpec | 实例规格非法。 |
| InvalidParameterValue.InvalidZoneIdError | 无效的可用区。 |
| InvalidParameterValue.ProjectIdNotFound | 找不到该ProjectId |
| InvalidParameterValue.RegionZoneUnavailable | 所选地域和可用区不可用。 |
| InvalidParameterValue.SubnetNotFound | 找不到所选子网。 |
| InvalidParameterValue.VpcNotFound | 找不到所选VPC网络。 |
| LimitExceeded.UserInstanceLimit | 用户实例个数超出限制。 |
| OperationDenied.InsufficientBalanceError | 账号余额不足。 |
| OperationDenied.UserNotAuthenticatedError | 用户未进行实名认证，请先进行实名认证才可购买。 |
| UnauthorizedOperation.NotRealNameAccount | 非实名用户禁止购买。 |
| UnauthorizedOperation.PermissionDenied | CAM鉴权不通过。 |
