云数据库 MongoDB 创建云数据库实例（包年包月）

1. 接口描述

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

本接口(CreateDBInstance)用于创建包年包月的MongoDB云数据库实例。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateDBInstance。
Version	是	String	公共参数，本接口取值：2018-04-08。
Region	是	String	公共参数，详见产品支持的地域列表。
SecondaryNum	是	Integer	每个副本集内从节点个数示例值：2
Memory	是	Integer	实例内存大小，单位：GB 示例值：4
Volume	是	Integer	实例硬盘大小，单位：GB 示例值：100
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：高IO万兆。示例值：HIO10G
GoodsNum	是	Integer	实例数量，默认值为1, 最小值1，最大值为10 示例值：1
Zone	是	String	实例所属区域名称，格式如：ap-guangzhou-2 示例值：ap-guangzhou-2
TimeSpan	是	Integer	时长，购买月数示例值：1
Password	是	String	实例密码示例值：********
ProjectId	否	Integer	项目ID，不填为默认项目示例值：0
SecurityGroup.N	否	Array of String	安全组参数示例值：sg-1ad2****
UniqVpcId	否	String	私有网络ID，如果不传则默认选择基础网络示例值：vpc-0akb****
UniqSubnetId	否	String	私有网络下的子网ID，如果设置了 VpcId，则 SubnetId必填示例值：subnet-fyrt****（
InstanceType	否	String	实例类型，REPLSET-副本集，SHARD-分片集群，默认为REPLSET 示例值：REPLSET

3. 输出参数

参数名称	类型	描述
DealId	String	订单ID 示例值：7142863
InstanceIds	Array of String	创建的实例ID列表示例值：["cmgo-po5f****"]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

客户需要通过API创建包年包月云数据库实例

输入示例

POST / HTTP/1.1
Host: mongodb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDBInstance
<公共请求参数>

{
    "Zone": "ap-guangzhou-2",
    "UniqVpcId": "vpc-0akbol5v",
    "TimeSpan": "1",
    "ProjectId": "0",
    "MachineCode": "TGIO",
    "GoodsNum": "1",
    "Volume": "250",
    "SecondaryNum": "2",
    "UniqSubnetId": "subnet-fyrtjbqw",
    "Memory": "4",
    "MongoVersion": "MONGO_42_WT",
    "Password": "pwd123456"
}

输出示例

{
    "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。

Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InvalidParameter	参数错误。
InvalidParameter.ZoneClosed	可用区已关闭售卖。
InvalidParameterValue.MachineTypeError	错误的机型。
InvalidParameterValue.MongoVersionError	实例版本错误。
InvalidParameterValue.PasswordRuleFailed	密码不符合规范。
InvalidParameterValue.RegionError	无效的地域。
InvalidParameterValue.SecondaryNumError	从节点数错误。
InvalidParameterValue.SpecNotOnSale	购买规格错误。
InvalidParameterValue.VpcIdOrSubnetIdNotFound	未找到虚拟网络（子网）。
InvalidParameterValue.ZoneError	无效的可用区。

创建云数据库实例（包年包月）

本页目录：