1. 接口描述
接口请求域名: mongodb.tencentcloudapi.com 。
本接口(CreateDBInstanceHour)用于创建按量计费的MongoDB云数据库实例。
默认接口请求频率限制:20次/秒。
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 |
| NodeNum | 是 | Integer |
示例值:2 |
| MongoVersion | 是 | String | 指版本信息。具体支持的版本信息 ,请通过接口 DescribeSpecInfo 获取。
示例值:MONGO_44_WT |
| MachineCode | 是 | String | 产品推荐规格类型:
产品白名单规格类型:
注意:白名单规格类型为白名单控制,如若需要,请 提交工单 申请 示例值:GE.LD.T1 |
| GoodsNum | 是 | Integer | 实例数量,最小值1,最大值为30。 示例值:1 |
| Zone | 是 | String | 可用区信息,输入格式如:ap-guangzhou-2。
示例值:ap-guangzhou-3 |
| ClusterType | 是 | String | 实例架构类型。
示例值:REPLSET |
| VpcId | 否 | String | 私有网络ID。 示例值:vpc-k515**** |
| SubnetId | 否 | String | 私有网络 VPC 的子网 ID。 示例值:subnet-60dr**** |
| Password | 否 | String | 实例密码。设置要求如下:
示例值:*** |
| ProjectId | 否 | Integer | 项目ID。
示例值:1 |
| Tags.N | 否 | Array of TagInfo | 实例标签信息。 |
| Clone | 否 | Integer | 实例类型。
示例值:1 |
| Father | 否 | String | 父实例 ID。
示例值:cmgo-nh1o**** |
| SecurityGroup.N | 否 | Array of String | 安全组 ID。 请登录安全组控制台页面获取与数据库实例同地域的安全组 ID。 示例值:["sg-1s3c****"] |
| RestoreTime | 否 | String | 克隆实例回档时间。
示例值:2022-09-10 15:04:05 |
| InstanceName | 否 | String | 实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。
示例值:testInstance_{R:3} |
| AvailabilityZoneList.N | 否 | Array of String | 若多可用区部署云数据库实例,指定多可用区列表。
示例值:["ap-guangzhou-2","ap-guangzhou-3","ap-guangzhou-4"] |
| MongosCpu | 否 | Integer | Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。 示例值:1 |
| MongosMemory | 否 | Integer | Mongos 内存大小。
示例值:2 |
| MongosNodeNum | 否 | Integer | Mongos 数量。购买分片集群时,必须填写。
示例值: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。
示例值:tpl-0vswu**** |
| CpuCore | 否 | Integer | 实例CPU核大小,单位:C。具体售卖的CPU规格,请通过接口 DescribeSpecInfo 获取。 示例值:2 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DealId | String | 订单ID。 示例值:2019070916000000350241612094**** |
| InstanceIds | Array of String | 创建的实例ID列表。 示例值:["cmgo-m26c****"] |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建云数据库实例(按量计费)
当前示例仅适合4.0版本,其余版本请严格参考传入参数中各版本说明项
输入示例
POST / HTTP/1.1
Host: mongodb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDBInstanceHour
<公共请求参数>
{
"Zone": "ap-guangzhou-3",
"GoodsNum": 1,
"Clone": 1,
"Memory": 4,
"ClusterType": "REPLSET",
"Volume": 250,
"NodeNum": 2,
"ReplicateSetNum": 1,
"MachineCode": "HIO10G",
"MongoVersion": "MONGO_50_WT"
}
输出示例
{
"Response": {
"RequestId": "eaf9b19d-5ad4-4ca2-9fc4-a319aeb9181f",
"DealId": "20190709160000003502416120946732",
"InstanceIds": [
"cmgo-m26c****"
]
}
}
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 | 当前版本不支持该操作。 |