创建云数据库实例(按量计费)

最近更新时间:2025-04-25 01:45:15

我的收藏

1. 接口描述

接口请求域名: mongodb.tencentcloudapi.com 。

本接口(CreateDBInstanceHour)用于创建按量计费的MongoDB云数据库实例,可通过传入实例规格、实例类型、MongoDB版本、购买时长和数量等信息创建云数据库实例。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateDBInstanceHour。
Version String 公共参数,本接口取值:2018-04-08。
Region String 公共参数,详见产品支持的 地域列表
Memory Integer 实例内存大小,单位:GB
示例值:4
Volume Integer 实例硬盘大小,单位:GB
示例值:250
ReplicateSetNum Integer 副本集个数,1为单副本集实例,大于1为分片集群实例,最大不超过10
示例值:1
SecondaryNum Integer 每个副本集内从节点个数,目前只支持从节点数为2
示例值:2
EngineVersion String MongoDB引擎版本,值包括MONGO_3_WT 、MONGO_3_ROCKS和MONGO_36_WT
示例值:MONGO_3_WT
Machine String 实例类型,HIO10G:高IO万兆。
示例值:HIO10G
GoodsNum Integer 实例数量,默认值为1, 最小值1,最大值为10
示例值:1
Zone String 可用区信息,格式如:ap-guangzhou-2
示例值:ap-guangzhou-3
InstanceRole String 实例角色,默认传MASTER即可
示例值:MASTER
InstanceType String 实例类型,REPLSET-副本集,SHARD-分片集群
示例值:REPLSET
Encrypt Integer 数据是否加密,当且仅当引擎版本为MONGO_3_ROCKS,可以选择加密
示例值:1
VpcId String 私有网络ID,如果不传则默认选择基础网络
示例值:vpc-112****
SubnetId String 私有网络下的子网ID,如果设置了 VpcId,则 SubnetId必填
示例值:subnet-12asd****
ProjectId Integer 项目ID,不填为默认项目
示例值:1118179
SecurityGroup.N Array of String 安全组参数
示例值:sg-123a****
UniqVpcId String 私有网络ID,如果不传则默认选择基础网络
示例值:vpc-112****
UniqSubnetId String 私有网络下的子网ID,如果设置了 VpcId,则 SubnetId必填
示例值:subnet-12asd****

3. 输出参数

参数名称 类型 描述
DealId String 订单ID
示例值:2019070916000000350241612094****
InstanceIds Array of String 创建的实例ID列表
示例值:["cmgo-m26****"]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 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 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InvalidParameterValue.InstanceTypeError 实例类型取值错误,需要指定实例类型为副本集或分片。
InvalidParameterValue.MachineTypeError 错误的机型。
InvalidParameterValue.MongoVersionError 实例版本错误。
InvalidParameterValue.RegionError 无效的地域。
InvalidParameterValue.SpecNotOnSale 购买规格错误。
InvalidParameterValue.ZoneError 无效的可用区。