API 文档

文档中心 > 云数据库 MongoDB > API 文档 > 实例相关接口 > 创建云数据库实例(包年包月)

创建云数据库实例(包年包月)

最近更新时间:2020-11-30 08:24:15

我的收藏

1. 接口描述

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

本接口(CreateDBInstance)用于创建包年包月的MongoDB云数据库实例。接口支持的售卖规格,可从查询云数据库的售卖规格(DescribeSpecInfo)获取。

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:mongodb.ap-shanghai-fsi.tencentcloudapi.com。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateDBInstance。
Version String 公共参数,本接口取值:2019-07-25。
Region String 公共参数,详见产品支持的 地域列表
NodeNum Integer 每个副本集内节点个数,当前副本集节点数固定为3,分片从节点数可选,具体参照查询云数据库的售卖规格返回参数
Memory Integer 实例内存大小,单位:GB
Volume Integer 实例硬盘大小,单位:GB
MongoVersion String 版本号,具体支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果。参数与版本对应关系是MONGO_3_WT:MongoDB 3.2 WiredTiger存储引擎版本,MONGO_3_ROCKS:MongoDB 3.2 RocksDB存储引擎版本,MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本,MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本
GoodsNum Integer 实例数量, 最小值1,最大值为10
Zone String 实例所属区域名称,格式如:ap-guangzhou-2
Period Integer 实例时长,单位:月,可选值包括 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]
MachineCode String 机器类型,HIO:高IO型;HIO10G:高IO万兆型;STDS5:标准型
ClusterType String 实例类型,REPLSET-副本集,SHARD-分片集群,STANDALONE-单节点
ReplicateSetNum Integer 副本集个数,创建副本集实例时,该参数必须设置为1;创建分片实例时,具体参照查询云数据库的售卖规格返回参数;若为单节点实例,该参数设置为0
ProjectId Integer 项目ID,不设置为默认项目
VpcId String 私有网络 ID,如果不传则默认选择基础网络,请使用 查询私有网络列表
SubnetId String 私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 查询子网列表
Password String 实例密码,不设置该参数则需要在创建完成后通过设置密码接口初始化实例密码。密码必须是8-16位字符,且至少包含字母、数字和字符 !@#%^*() 中的两种
Tags.N Array of TagInfo 实例标签信息
AutoRenewFlag Integer 自动续费标记,可选值为:0 - 不自动续费;1 - 自动续费。默认为不自动续费
AutoVoucher Integer 是否自动选择代金券,可选值为:1 - 是;0 - 否; 默认为0
Clone Integer 1:正式实例,2:临时实例,3:只读实例,4:灾备实例
Father String 若是只读,灾备实例,Father必须填写,即主实例ID
SecurityGroup.N Array of String 安全组

3. 输出参数

参数名称 类型 描述
DealId String 订单ID
InstanceIds Array of String 创建的实例ID列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建包年包月的云数据库实例

输入示例

https://mongodb.tencentcloudapi.com/?Action=CreateDBInstance
&Memory=4
&Volume=250
&GoodsNum=1
&Zone=ap-guangzhou-2
&UniqVpcId=vpc-0akbol5v
&UniqSubnetId=subnet-fyrtjbqw
&ProjectId=0
&MongoVersion=MONGO_3_WT
&MachineCode=TGIO
&NodeNum=3
&Period=1
&Password=pwd123456
&ClusterType=REPLSET
&ReplicateSetNum=1
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "d88095e5-50e8-4245-a0cf-993a536f9b20",
    "DealId": "7142863",
    "InstanceIds": [
      "cmgo-po5f899l"
    ]
  }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameter 参数错误。
InvalidParameter.PermissionDenied 当前子帐号无权执行该操作。
InvalidParameterValue.InvalidTradeOperation 计费相关错误,不允许对当前实例进行对应的新购/续费/配置变更操作。
InvalidParameterValue.MachineTypeError 错误的机型。
InvalidParameterValue.MongoVersionError 实例版本错误。
InvalidParameterValue.NotFoundInstance 未找到实例。
InvalidParameterValue.PasswordRuleFailed 密码不符合规范。
InvalidParameterValue.ProjectNotFound 项目不存在。
InvalidParameterValue.RegionError 无效的地域。
InvalidParameterValue.ReplicaSetNumError 副本集(分片)数量错误。
InvalidParameterValue.SecondaryNumError 从节点数错误。
InvalidParameterValue.SpecNotOnSale 购买规格错误。
InvalidParameterValue.TagNotFound 未找到指定的标签。
InvalidParameterValue.VpcIdOrSubnetIdNotFound 未找到虚拟网络(子网)。
InvalidParameterValue.ZoneClosed 可用区已关闭售卖。
InvalidParameterValue.ZoneError 无效的可用区。
目录