1. 接口描述
接口请求域名: cynosdb.tencentcloudapi.com 。
本接口(CreateClusters)用于新购集群。
默认接口请求频率限制:20次/秒。
                推荐使用 API Explorer
            
            点击调试
        
                API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
            
        2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 | 
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateIntegrateCluster。 | 
| Version | 是 | String | 公共参数,本接口取值:2019-01-07。 | 
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo 。 | 
| Zone | 是 | String | 可用区 示例值:ap-guangzhou-2  | 
| VpcId | 是 | String | 所属VPC网络ID 示例值:vpc-ba48u0jt  | 
| SubnetId | 是 | String | 所属子网ID 示例值:subnet-nw2hec3g  | 
| DbVersion | 是 | String | 数据库版本,取值范围:  示例值:5.7  | 
| ProjectId | 否 | Integer | 所属项目ID 示例值:0  | 
| ClusterName | 否 | String | 集群名称,长度小于64个字符,每个字符取值范围:大/小写字母,数字,特殊符号('-','_','.') 示例值:集群-demo  | 
| AdminPassword | 否 | String | 账号密码(8-64个字符,包含大小写英文字母、数字和符号~!@#$%^&*_-+=`|(){}[]:;'<>,.?/中的任意三种) 示例值:test@km1  | 
| Port | 否 | Integer | 端口,默认3306,取值范围[0, 65535) 示例值:3306  | 
| PayMode | 否 | Integer | 计费模式,按量计费:0,包年包月:1。默认按量计费。 示例值:0  | 
| Count | 否 | Integer | 购买集群数,可选值范围[1,3],默认为1 示例值:1  | 
| StorageLimit | 否 | Integer | 普通实例存储上限,单位GB 当DbType为MYSQL,且存储计费模式为预付费时,该参数需不大于cpu与memory对应存储规格上限 示例值:10  | 
| TimeSpan | 否 | Integer | 包年包月购买时长 示例值:1  | 
| TimeUnit | 否 | String | 包年包月购买时长单位,['s','d','m','y'] 示例值:m  | 
| AutoRenewFlag | 否 | Integer | 包年包月购买是否自动续费,默认为0。 0标识默认续费方式,1表示自动续费,2表示不自动续费。 示例值:0  | 
| AutoVoucher | 否 | Integer | 是否自动选择代金券 1是 0否 默认为0 示例值:0  | 
| ResourceTags.N | 否 | Array of Tag | 集群创建需要绑定的tag数组信息 | 
| StoragePayMode | 否 | Integer | 集群存储计费模式,按量计费:0,包年包月:1。默认按量计费 当DbType为MYSQL时,在集群计算计费模式为后付费(包括DbMode为SERVERLESS)时,存储计费模式仅可为按量计费 回档与克隆均不支持包年包月存储 示例值:0  | 
| SecurityGroupIds.N | 否 | Array of String | 安全组id数组 示例值:["sg-1kdfm1"]  | 
| AlarmPolicyIds.N | 否 | Array of String | 告警策略Id数组 示例值:["p-1kdfm1"]  | 
| 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 示例值:1  | 
| SlaveZone | 否 | String | 多可用区地址 示例值:ap-guangzhou-4  | 
| InstanceInitInfos.N | 否 | Array of IntegrateInstanceInfo | 实例初始化配置信息,主要用于购买集群时选不同规格实例 | 
| GdnId | 否 | String | 全球数据库唯一标识 示例值:cynosmysql-gdn-dbsgxagb  | 
| ProxyConfig | 否 | ProxyConfigInfo | 数据库代理配置 | 
| AutoArchive | 否 | String | 是否自动归档 示例值:yes  | 
| AutoArchiveDelayHours | 否 | Integer | 暂停后的归档处理时间 示例值:12  | 
| EncryptMethod | 否 | String | 加密方法(由加密算法和密钥对版本组成) 示例值:RSA-2048-v1  | 
| IntegrateCreateClusterConfig | 否 | IntegrateCreateClusterConfig | 集成集群配置信息 | 
| StorageVersion | 否 | String | 存储架构类型。 枚举值:1.0/2.0 默认值:1.0 示例值:1.0  | 
3. 输出参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| TranId | String | 冻结流水ID 示例值:20250812065021475117821  | 
| DealNames | Array of String | 订单号 示例值:[ "20250812065021475117801", "20250812065021475117811" ]  | 
| ResourceIds | Array of String | 资源ID列表(该字段已不再维护,请使用dealNames字段查询接口DescribeResourcesByDealName获取资源ID) 示例值:[ "cynosdbmysql-ins-i085h27o" ]  | 
| ClusterIds | Array of String | 集群ID列表(该字段已不再维护,请使用dealNames字段查询接口DescribeResourcesByDealName获取集群ID) 示例值:[ "cynosdbmysql-aembgh5z" ]  | 
| BigDealIds | Array of String | 大订单号 注意:此字段可能返回 null,表示取不到有效值。 示例值:["20250812065021475117801", "20250812065021475117811" ]  | 
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 | 
4. 示例
示例1 创建集成集群
Create Integrate Cluster
输入示例
POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateIntegrateCluster
<公共请求参数>
{
    "DbVersion": "8.0",
    "InstanceInitInfos": [
        {
            "Cpu": 1,
            "DeviceType": "common",
            "InstanceCount": 1,
            "InstanceType": "rw",
            "Memory": 2
        }
    ],
    "IntegrateCreateClusterConfig": {
        "BackupSaveDays": 7,
        "BinlogSaveDays": 8,
        "SemiSyncTimeout": 1000
    },
    "SubnetId": "subnet-3du8lpau",
    "VpcId": "vpc-r2dqqiyv",
    "Zone": "ap-guangzhou-4"
}
输出示例
{
    "Response": {
        "BigDealIds": [],
        "ClusterIds": [],
        "DealNames": [
            "20250909448021542853581"
        ],
        "RequestId": "081ec9cb-d476-4202-8943-966e1e552e3f",
        "ResourceIds": [],
        "TranId": "20250909448021542853591"
    }
}
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: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for Ruby: CNB, 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鉴权不通过。 |