云数据库 MongoDB
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 云数据库 MongoDB > API 文档 > 实例相关接口 > 创建云数据库实例（包年包月）

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

最近更新时间：2024-03-12 01:40:20

我的收藏

本页目录：

1. 接口描述

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

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：CreateDBInstance。
Version 是 String 公共参数，本接口取值：2019-07-25。
Region 是 String 公共参数，详见产品支持的 地域列表。
NodeNum 是 Integer 指每个副本集内节点个数。具体售卖规格，请通过接口 DescribeSpecInfo 获取。
示例值：3
Memory 是 Integer 实例内存大小，单位：GB。
示例值：4
Volume 是 Integer 实例硬盘大小，单位：GB。
示例值：250
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_3_WT
GoodsNum 是 Integer 实例数量, 最小值1，最大值为10。
示例值：1
Zone 是 String 可用区信息，输入格式如：ap-guangzhou-2。
- 具体信息，请通过接口 DescribeSpecInfo 获取。
- 该参数为主可用区，如果多可用区部署，Zone必须是AvailabilityZoneList中的一个。
示例值：ap-guangzhou-2
Period 是 Integer 实例时长，单位：月，可选值包括 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。
示例值：1
MachineCode 是 String 机器类型。
- HIO：高IO型。
- HIO10G：高IO万兆。
示例值：HIO10G
ClusterType 是 String 实例架构类型。
- REPLSET：副本集。
- SHARD：分片集群。
示例值：REPLSET
ReplicateSetNum 是 Integer 指副本集数量。
- 创建副本集实例，该参数只能为1。
- 创建分片实例，指分片的数量。具体售卖规格，请通过接口 DescribeSpecInfo 获取。
示例值：1
ProjectId 否 Integer 项目ID。若不设置该参数，则为默认项目。
示例值：0
VpcId 否 String 私有网络ID。如果不设置该参数，则默认选择基础网络。
示例值：vpc-0akbol5v
SubnetId 否 String 私有网络下的子网 ID，如果配置参数 VpcId，则 SubnetId必须配置。
示例值：subnet-fyrtjbqw
Password 否 String 实例密码。自定义密码长度为8-32个字符，至少包含字母、数字和字符（!@#%^*()_）中的两种。
示例值：pwd123456
Tags.N 否 Array of TagInfo 实例标签信息。
AutoRenewFlag 否 Integer 自动续费标记。
- 0：不自动续费。默认为不自动续费。
- 1：自动续费。
示例值：1
AutoVoucher 否 Integer 是否自动选择代金券。
- 1：是。
- 0：否。默认为0。
示例值：1
Clone 否 Integer 实例类型。
- 1：正式实例。
- 3：只读实例。
- 4：灾备实例。
示例值：1
Father 否 String 父实例 ID。当参数Clone为3或者4时，即实例为只读或灾备实例时，该参数必须配置。
SecurityGroup.N 否 Array of String 安全组。
RestoreTime 否 String 克隆实例回档时间。
- 若为克隆实例，则必须配置该参数。输入格式示例：2021-08-13 16:30:00。
- 回档时间范围：仅能回档7天内时间点的数据。
InstanceName 否 String 实例名称。仅支持长度为60个字符的中文、英文、数字、下划线_、分隔符- 。
AvailabilityZoneList.N 否 Array of String 多可用区部署的节点列表。具体信息，请通过接口 DescribeSpecInfo获取。
- 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如：3节点集群不支持2个节点部署在同一个区。
- 不支持4.2及以上版本。
- 不支持只读灾备实例。
- 不能选择基础网络。
MongosCpu 否 Integer Mongos CPU 核数，购买MongoDB 4.2 及以上WiredTiger存储引擎版本的分片集群时，必须填写。具体售卖规格，请通过接口 DescribeSpecInfo 获取。
MongosMemory 否 Integer Mongos 内存大小。购买MongoDB 4.2 及以上WiredTiger存储引擎版本的分片集群时，必须填写。具体售卖规格，请通过接口 DescribeSpecInfo 获取。
MongosNodeNum 否 Integer Mongos 数量。购买MongoDB 4.2 及以上WiredTiger存储引擎版本的分片集群时，必须填写。具体售卖规格，请通过接口 DescribeSpecInfo 获取。为了保障高可用，取值范围为[3,32]。
ReadonlyNodeNum 否 Integer 只读节点数量，取值范围[0,5]。
ReadonlyNodeAvailabilityZoneList.N 否 Array of String 指只读节点所属可用区。跨可用区部署实例，参数ReadonlyNodeNum不为0时，必须配置该参数。
HiddenZone 否 String Hidden节点所属可用区。跨可用区部署实例，必须配置该参数。

3. 输出参数

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

4. 示例

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

当前示例仅适合4.0版本，其余版本请严格参考传入参数中各版本说明项

输入示例

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

{
    "VpcId": "vpc-0akbol5v",
    "GoodsNum": "1",
    "Zone": "ap-guangzhou-2",
    "ProjectId": "0",
    "MachineCode": "HIO10G",
    "Period": "1",
    "ClusterType": "REPLSET",
    "Volume": "250",
    "MongoVersion": "MONGO_40_WT",
    "NodeNum": "3",
    "ReplicateSetNum": "1",
    "Memory": "4",
    "SubnetId": "subnet-fyrtjbqw",
    "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。

命令行工具

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 无效的可用区。
UnsupportedOperation.VersionNotSupport 当前版本不支持该操作。
中国站