1. 接口描述
接口请求域名： mongodb.tencentcloudapi.com 。
本接口（CreateDBInstanceHour）用于创建按量计费的MongoDB云数据库实例。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateDBInstanceHour。 |
| Version | 是 | String | 公共参数，本接口取值：2019-07-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Memory | 是 | Integer | 实例内存大小，单位：GB。具体售卖的内存规格，请通过接口 DescribeSpecInfo 获取。 示例值：4 |
| Volume | 是 | Integer | 实例硬盘大小，单位：GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围，请通过接口 DescribeSpecInfo 获取。 示例值：100 |
| ReplicateSetNum | 是 | Integer | - 创建副本集实例，指副本集数量，该参数只能为1。 - 创建分片集群实例，指分片的数量。请通过接口DescribeSpecInfo查询分片数量的取值范围，其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。 示例值：1 |
| NodeNum | 是 | Integer | - 创建副本集实例，指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数，请通过接口 DescribeSpecInfo 获取。 - 创建分片集群实例，指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数，请通过接口 DescribeSpecInfo 获取。 示例值：2 |
| MongoVersion | 是 | String | 指版本信息。具体支持的版本信息 ，请通过接口 DescribeSpecInfo 获取。 - MONGO_36_WT：MongoDB 3.6 WiredTiger存储引擎版本。 - MONGO_40_WT：MongoDB 4.0 WiredTiger存储引擎版本。 - MONGO_42_WT：MongoDB 4.2 WiredTiger存储引擎版本。 - MONGO_44_WT：MongoDB 4.4 WiredTiger存储引擎版本。 - MONGO_50_WT：MongoDB 5.0 WiredTiger存储引擎版本。 - MONGO_60_WT：MongoDB 6.0 WiredTiger存储引擎版本。 示例值：MONGO_44_WT |
| MachineCode | 是 | String | 产品规格类型。 - HIO10G：通用高HIO万兆型。 - HCD：云盘版类型。 示例值：HIO10G |
| GoodsNum | 是 | Integer | 实例数量，最小值1，最大值为10。 示例值：1 |
| Zone | 是 | String | 可用区信息，输入格式如：ap-guangzhou-2。 - 具体信息，请通过接口 DescribeSpecInfo 获取。 - 该参数为主可用区，如果多可用区部署，Zone必须是AvailabilityZoneList中的一个。 示例值：ap-guangzhou-3 |
| ClusterType | 是 | String | 实例架构类型。 - REPLSET：副本集。 - SHARD：分片集群。 示例值：REPLSET |
| VpcId | 否 | String | 私有网络ID。请登录 私有网络控制台 查询确认正确的ID。 示例值：vpc-pxyzim13 示例值：vpc-k515**** |
| SubnetId | 否 | String | 私有网络VPC的子网。请登录 私有网络控制台 查询子网列表确认正确的 ID。 示例值：subnet-7jbabche 示例值：subnet-60dr**** |
| Password | 否 | String | 实例密码。设置要求如下： - 字符个数为[8,32]。 - 可输入[A,Z]、[a,z]、[0,9]范围内的字符。 - 可输入的特殊字符包括：感叹号“!”，at“@”，警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。 - 不能设置单一的字母或者数字。 示例值：**** |
| ProjectId | 否 | Integer | 项目ID。 - 若不设置该参数，则为默认项目。 - 在 MongoDB 控制台项目管理页面，可获取项目ID。 示例值：1 |
| Tags.N | 否 | Array of TagInfo | 实例标签信息。 |
| Clone | 否 | Integer | 实例类型。- 1：正式实例。- 3：只读实例。- 4：灾备实例。-5：克隆实例，注意：克隆实例RestoreTime为必填项。 示例值：1 |
| Father | 否 | String | 父实例 ID。当参数Clone为3或者4时，即实例为只读或灾备实例时，该参数必须配置。 示例值：cmgo-nh1o**** |
| SecurityGroup.N | 否 | Array of String | 安全组 ID。 示例值：sg-abc**** |
| RestoreTime | 否 | String | 克隆实例回档时间。 - 若为克隆实例，则必须配置该参数。输入格式示例：2021-08-13 16:30:00。 - 回档时间范围：仅能回档7天内时间点的数据。 示例值：2022-09-10 15:04:05 |
| InstanceName | 否 | String | 实例名称。仅支持长度为60个字符的中文、英文、数字、下划线_、分隔符- 。 示例值：testInstance |
| AvailabilityZoneList.N | 否 | Array of String | 若多可用区部署云数据库实例，指定多可用区列表。 - 多可用区部署实例，参数 Zone 指定实例主可用区信息；AvailabilityZoneList 指定所有可用区信息，包含主可用区。输入格式如：[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。 - 通过接口 DescribeSpecInfo 可获取云数据库不同地域规划的可用区信息，以便指定有效的可用区。 - 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如：3节点集群不支持2个节点部署在同一个区。 示例值：["ap-guangzhou-2","ap-guangzhou-3","ap-guangzhou-4"] |
| MongosCpu | 否 | Integer | Mongos CPU 核数，支持1、2、4、8、16。购买分片集群时，必须填写。 示例值：1 |
| MongosMemory | 否 | Integer | Mongos 内存大小。 - 购买分片集群时，必须填写。 - 单位：GB，支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。 示例值：2 |
| MongosNodeNum | 否 | Integer | Mongos 数量。购买分片集群时，必须填写。 - 单可用区部署实例，其数量范围为[3,32]。 - 多可用区部署实例，其数量范围为[6,32]。 示例值：3 |
| ReadonlyNodeNum | 否 | Integer | 只读节点数量，取值范围[0,5]。 示例值：0 |
| ReadonlyNodeAvailabilityZoneList.N | 否 | Array of String | 指只读节点所属可用区数组。跨可用区部署实例，参数ReadonlyNodeNum不为0时，必须配置该参数。 示例值：["ap-guangzhou-2"] |
| HiddenZone | 否 | String | Hidden节点所属可用区。跨可用区部署实例，必须配置该参数。 示例值：ap-guangzhou-2 |
| ParamTemplateId | 否 | String | 参数模板 ID。参数模板是一组 MongoDB 的参数并为预设置了参数值的集合，将一组有相同诉求的参数及值 存为模板，在创建实例时，可直接引用参数值到新实例。合理使用参数模板，可以提高MongoDB数据库的效率。模板列表从 DescribeDBInstanceParamTpl 接口获取，注意模板支持的版本。 示例值：tpl-0vswu**** |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DealId | String | 订单ID。 示例值：2019070916000000350241612094**** |
| InstanceIds | Array of String | 创建的实例ID列表。 示例值：["cmgo-m26c****"] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建云数据库实例（按量计费）
当前示例仅适合4.0版本，其余版本请严格参考传入参数中各版本说明项
输入示例
输出示例
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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| InvalidParameter.PermissionDenied | 当前子账号无权执行该操作。 |
| InvalidParameterValue.ClusterTypeError | 无效的实例类型。 |
| InvalidParameterValue.InvalidTradeOperation | 计费相关错误，不允许对当前实例进行对应的新购/续费/配置变更操作。 |
| InvalidParameterValue.MachineTypeError | 错误的机型。 |
| InvalidParameterValue.MongoVersionError | 实例版本错误。 |
| InvalidParameterValue.PasswordRuleFailed | 密码不符合规范。 |
| InvalidParameterValue.PostPaidInstanceBeyondLimit | 单个地域后付费实例数量超过限制。 |
| InvalidParameterValue.ProjectNotFound | 项目不存在。 |
| InvalidParameterValue.RegionError | 无效的地域。 |
| InvalidParameterValue.ReplicaSetNumError | 副本集（分片）数量错误。 |
| InvalidParameterValue.SpecNotOnSale | 购买规格错误。 |
| InvalidParameterValue.StatusAbnormal | 实例处于不允许操作的状态。 |
| InvalidParameterValue.TagNotFound | 未找到指定的标签。 |
| InvalidParameterValue.VpcIdOrSubnetIdNotFound | 未找到虚拟网络（子网）。 |
| InvalidParameterValue.ZoneClosed | 可用区已关闭售卖。 |
| InvalidParameterValue.ZoneError | 无效的可用区。 |
| UnsupportedOperation.VersionNotSupport | 当前版本不支持该操作。 |
