1. 接口描述
接口请求域名: cdb.tencentcloudapi.com 。
本接口(CreateDBInstanceHour)用于创建按量计费的实例,可通过传入实例规格、MySQL 版本号和数量等信息创建云数据库实例,支持主实例、灾备实例和只读实例的创建。
该接口为异步接口,您还可以使用 查询实例列表 接口查询该实例的详细信息。当该实例的 Status 为 1,且 TaskStatus 为 0,表示实例已经发货成功。
- 首先请使用 获取云数据库可售卖规格 接口查询可创建的实例规格信息,然后请使用 查询数据库价格 接口查询可创建实例的售卖价格;
- 单次创建实例最大支持 100 个,实例时长最大支持 36 个月;
- 支持创建 MySQL 5.5、MySQL 5.6 、MySQL 5.7 和 MySQL 8.0 版本;
- 支持创建主实例、灾备实例和只读实例;
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateDBInstanceHour。 |
| Version | 是 | String | 公共参数,本接口取值:2017-03-20。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| GoodsNum | 是 | Integer | 实例数量,默认值为 1,最小值 1,最大值为 100。 示例值:1 |
| Memory | 是 | Integer | 实例内存大小,单位:MB,请使用 获取云数据库可售卖规格 接口获取可创建的内存规格。 示例值:1000 |
| Volume | 是 | Integer | 实例硬盘大小,单位:GB,请使用 获取云数据库可售卖规格 接口获取可创建的硬盘范围。 示例值:50 |
| EngineVersion | 否 | String | MySQL 版本,值包括:5.5、5.6、5.7和8.0,请使用 获取云数据库可售卖规格 接口获取可创建的实例版本。 示例值:5.7 |
| UniqVpcId | 否 | String | 私有网络 ID,请使用 查询私有网络列表。 示例值:vpc-5l7l5q11 |
| UniqSubnetId | 否 | String | 私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 查询子网列表。 示例值:subnet-b5v6i111 |
| ProjectId | 否 | Integer | 项目 ID,不填为默认项目。 示例值:0 |
| Zone | 否 | String | 可用区信息,请使用 获取云数据库可售卖规格 接口获取可创建的可用区。 示例值:ap-beijing-3 |
| MasterInstanceId | 否 | String | 实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 查询实例列表 接口查询云数据库实例 ID。 示例值:cdb-q72dno11 |
| InstanceRole | 否 | String | 实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。 示例值:master |
| MasterRegion | 否 | String | 主实例地域信息,购买灾备、RO实例时,该字段必填。 示例值:ap-beijing |
| Port | 否 | Integer | 自定义端口,端口支持范围:[1024 - 65535]。 示例值:3306 |
| Password | 否 | String | 设置 root 账号密码,密码规则:8 - 64 个字符,至少包含字母、数字、字符(支持的字符:_+-&=!@#$%^*())中的两种,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。 示例值:your_password |
| ParamList.N | 否 | Array of ParamInfo | 参数列表,参数格式如 ParamList.0.Name=auto_increment&ParamList.0.Value=1。可通过 查询默认的可设置参数列表 查询支持设置的参数。 |
| ProtectMode | 否 | Integer | 数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。 示例值:0 |
| DeployMode | 否 | Integer | 多可用区域,默认为 0,支持值包括:0 - 表示单可用区,1 - 表示多可用区,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。 示例值:0 |
| SlaveZone | 否 | String | 备库 1 的可用区信息。 示例值:ap-beijing-3 |
| BackupZone | 否 | String | 备库 2 的可用区信息,默认为空,购买三节点主实例时可指定该参数。 示例值:ap-beijing-4 |
| SecurityGroup.N | 否 | Array of String | 安全组参数,可使用 查询项目安全组信息 接口查询某个项目的安全组详情。 示例值:["sg-9stjvjn1"] |
| RoGroup | 否 | RoGroup | 只读实例信息。购买只读实例时,该参数必传。 |
| AutoRenewFlag | 否 | Integer | 购买按量计费实例该字段无意义。 示例值:1 |
| InstanceName | 否 | String | 实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。 示例值:cdbzhang |
| ResourceTags.N | 否 | Array of TagInfo | 实例标签信息。 |
| DeployGroupId | 否 | String | 置放群组 ID。 示例值:ps-7t11vrwf |
| ClientToken | 否 | String | 用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间在48小时内唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。 示例值:*** |
| DeviceType | 否 | String | 实例隔离类型。支持值包括:"UNIVERSAL" - 通用型实例,"EXCLUSIVE" - 独享型实例,"BASIC_V2" - ONTKE 单节点实例,"CLOUD_NATIVE_CLUSTER" - 云盘版标准型,"CLOUD_NATIVE_CLUSTER_EXCLUSIVE" - 云盘版加强型。不指定则默认为通用型实例。 示例值:UNIVERSAL |
| ParamTemplateId | 否 | Integer | 参数模板 id。 示例值:0 |
| AlarmPolicyList.N | 否 | Array of Integer | 告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。 示例值:[7957756] |
| InstanceNodes | 否 | Integer | 实例节点数。对于 RO 和 基础版实例, 该值默认为1。 如果需要购买三节点实例, 请将该值设置为3 或指定 BackupZone 参数。当购买主实例,且未指定该参数和 BackupZone 参数时,该值默认是 2, 即购买两节点实例。 示例值:2 |
| Cpu | 否 | Integer | 实例cpu核数, 如果不传将根据memory指定的内存值自动填充对应的cpu值。 示例值:1 |
| AutoSyncFlag | 否 | Integer | 是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为:0 - 不自动发起灾备同步;1 - 自动发起灾备同步。该值默认为0。 示例值:1 |
| CageId | 否 | String | 金融围拢 ID 。 示例值:cage-test |
| ParamTemplateType | 否 | String | 默认参数模板类型。支持值包括:"HIGH_STABILITY" - 高稳定模板,"HIGH_PERFORMANCE" - 高性能模板,默认值是:"HIGH_STABILITY"。 示例值:HIGH_STABILITY |
| AlarmPolicyIdList.N | 否 | Array of String | 告警策略名数组,例如:["policy-uyoee9wg"],AlarmPolicyList不为空时该参数无效。 示例值:["policy-uyoee9wg"] |
| DryRun | 否 | Boolean | 是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.默认为false:发送正常请求,通过检查后直接创建实例。 示例值:true |
| EngineType | 否 | String | 实例引擎类型,默认为"InnoDB",支持值包括:"InnoDB","RocksDB"。 示例值:InnoDB |
| Vips.N | 否 | Array of String | 指定实例的IP列表。仅支持主实例指定,按实例顺序,不足则按未指定处理。 示例值:["172.1.1.1"] |
| DataProtectVolume | 否 | Integer | 云盘版实例的数据保护空间大小,单位 GB,设置范围1 - 10。 示例值:1 |
| ClusterTopology | 否 | ClusterTopology | 云盘版节点拓扑配置。 |
| DiskType | 否 | String | 硬盘类型,单节点(云盘)或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘,CLOUD_HSSD 表示增强型 SSD 云硬盘,CLOUD_PREMIUM 表示高性能云硬盘。 示例值:CLOUD_SSD |
| ClusterType | 否 | String | 集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群 示例值:cage |
| DestroyProtect | 否 | String | 开启或关闭实例销毁保护。on-开启,off-关闭 示例值:on |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DealIds | Array of String | 短订单 ID。 示例值:["20171201110011"] |
| InstanceIds | Array of String | 实例 ID 列表。 示例值:["cdb-pn6gd5jp"] |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 发货
输入示例
POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDBInstanceHour
<公共请求参数>
{
"GoodsNum": 1,
"Memory": 1000,
"Volume": 150,
"EngineVersion": "8.0",
"UniqVpcId": "vpc-xxxxxx",
"UniqSubnetId": "subnet-xxxxxx",
"ProjectId": 0,
"Zone": "540001",
"InstanceRole": "master",
"Port": 3306,
"ParamList": [
{
"Name": "lower_case_table_names",
"Value": "1"
}
],
"ProtectMode": 1,
"DeployMode": 0,
"SlaveZone": "540001",
"BackupZone": "0",
"SecurityGroup": [
"sg-xxxxx"
],
"InstanceName": "xxxxxxx",
"AlarmPolicyList": [
-1
],
"Cpu": 1,
"ParamTemplateType": "HIGH_STABILITY",
"EngineType": "InnoDB",
"DestroyProtect": "off"
}
输出示例
{
"Response": {
"DealIds": [
"20260330601111111111"
],
"InstanceIds": [
"cdb-xxxzz"
],
"RequestId": "d30a3795-ee9e-4dc7-bf93-1e7ab751b6f5"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| CdbError | 后端错误或者流程错误。 |
| FailedOperation.StatusConflict | 任务状态冲突。 |
| InternalError.CdbError | 系统错误。 |
| InternalError.DatabaseAccessError | 数据库内部错误。 |
| InternalError.DfwError | 安全组操作错误。 |
| InternalError.TradeError | 交易系统错误。 |
| InternalError.UndefinedError | 未知错误。 |
| InternalError.VpcError | 私有网络或子网错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InstanceNotFound | 实例不存在。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.ActionNotSupport | 不支持的操作。 |
| OperationDenied.OtherOderInProcess | 当前有其他订单正在处于下单过程中,请稍后重试。 |
| OperationDenied.UserHasNoStrategy | 用户没有该策略权限。 |
| OperationDenied.WrongPassword | 密码错误或校验未通过。 |