1. 接口描述
接口请求域名: mongodb.tencentcloudapi.com 。
本接口(CreateDBInstanceHour)用于创建按量计费的MongoDB云数据库实例(包括主实例、灾备实例和只读实例),可通过传入实例规格、实例类型、MongoDB版本、购买时长和数量等信息创建云数据库实例。
默认接口请求频率限制:20次/秒。
注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:mongodb.ap-shanghai-fsi.tencentcloudapi.com。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateDBInstanceHour |
Version | 是 | String | 公共参数,本接口取值:2018-04-08 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Memory | 是 | Integer | 实例内存大小,单位:GB |
Volume | 是 | Integer | 实例硬盘大小,单位:GB |
ReplicateSetNum | 是 | Integer | 副本集个数,1为单副本集实例,大于1为分片集群实例,最大不超过10 |
SecondaryNum | 是 | Integer | 每个副本集内从节点个数,目前只支持从节点数为2 |
EngineVersion | 是 | String | MongoDB引擎版本,值包括MONGO_3_WT 、MONGO_3_ROCKS和MONGO_36_WT |
Machine | 是 | String | 实例类型,GIO:高IO版;TGIO:高IO万兆 |
GoodsNum | 是 | Integer | 实例数量,默认值为1, 最小值1,最大值为10 |
Zone | 是 | String | 可用区信息,格式如:ap-guangzhou-2 |
InstanceRole | 是 | String | 实例角色,支持值包括:MASTER-表示主实例,DR-表示灾备实例,RO-表示只读实例 |
InstanceType | 是 | String | 实例类型,REPLSET-副本集,SHARD-分片集群 |
Encrypt | 否 | Integer | 数据是否加密,当且仅当引擎版本为MONGO_3_ROCKS,可以选择加密 |
VpcId | 否 | String | 私有网络ID,如果不传则默认选择基础网络 |
SubnetId | 否 | String | 私有网络下的子网ID,如果设置了 VpcId,则 SubnetId必填 |
ProjectId | 否 | Integer | 项目ID,不填为默认项目 |
SecurityGroup.N | 否 | Array of String | 安全组参数 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DealId | String | 订单ID |
InstanceIds | Array of String | 创建的实例ID列表 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建云数据库实例(按量计费)
客户需要通过API创建按量计费的云数据库实例
输入示例
https://mongodb.tencentcloudapi.com/?Action=CreateDBInstanceHour
&Memory=4
&Volume=250
&ReplicateSetNum=1
&SecondaryNum=2
&EngineVersion=MONGO_3_WT
&Machine=TGIO
&GoodsNum=1
&Zone=ap-guangzhou-3
&InstanceRole=MASTER
&InstanceType=REPLSET
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "eaf9b19d-5ad4-4ca2-9fc4-a319aeb9181f",
"DealId": "20190709160000003502416120946732",
"InstanceIds": [
"cmgo-m26c6jsf"
]
}
}
5. 开发者资源
API Explorer
该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。