该接口用于创建MongoDB副本集实例,同时也可用于克隆MongoDB副本集实例。

请确保在使用该接口前,已充分了解云数据库MongoDB产品的收费方式和价格

关于云数据库MongoDB实例的规格,请参见实例规格表

如需创建分片集群实例,可通过调用CreateShardingDBInstance接口创建。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateDBInstance

系统规定参数。取值:CreateDBInstance

RegionId String cn-hangzhou

地域ID,您可以调用DescribeRegions查询。

ClientToken String ETnLKlblzczshOTUbOCz****

用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。

ZoneId String cn-hangzhou-b

可用区ID,您可以通过调用DescribeRegions查询。

Engine String MongoDB

数据库引擎,取值:MongoDB

EngineVersion String 4.2

数据库版本号。取值如下:

  • 5.0
  • 4.4
  • 4.2
  • 4.0
  • 3.4
    说明 调用此接口用于克隆实例时,数据库版本号必须和源数据库的一致。
DBInstanceClass String dds.mongo.standard

实例规格,取值详情请参见实例规格表,您也可以调用DescribeAvailableResource接口查看实例规格。

DBInstanceStorage Integer 10

实例存储空间,取值范围为10~3000 GB,步长为10 GB。

说明 具体取值受实例规格约束,详情请参见实例规格表
DBInstanceDescription String 测试数据库1

实例名称,设置规则如下:

  • 以中文、英文字母开头。
  • 可以包含数字、中文、英文、下划线(_)和短横线(-)。
  • 长度为2~256个字符。
SecurityIPList String 10.23.XX.XX

实例的IP白名单,以逗号隔开,不可重复,最多1000个IP。

说明
  • 支持格式:%,0.0.0.0/0,10.23.12.24(IP)或10.23.12.24/24(CIDR模式,无类域间路由,/24表示地址前缀的长度,范围为1~32)。
  • %和0.0.0.0/0表示任何IP地址都可以访问实例的数据库,属于高危设置,请谨慎设置。
AccountPassword String Alitest!159

root账号的密码。密码规则如下:

  • 由大写字母、小写字母、数字、特殊字符中的至少三种组成,特殊字符为!#$%^&*()_+-=
  • 长度为8~32位。
ChargeType String PrePaid

实例的付费类型。取值如下:

  • PostPaid:后付费(按量付费)。
  • PrePaid:预付费(包年包月)。

默认付费类型为PostPaid(按量付费)。

说明 当该参数的值为PrePaid时,您还需要配置Period参数。
Period Integer 1

实例的购买时长,单位为月。取值范围为:1~9122436

说明ChargeType参数值为PrePaid时,本参数才可用且必须传入。
NetworkType String VPC

实例的网络类型,取值:

  • Classic:经典网络。
  • VPC:专有网络。

默认网络类型为Classic(经典网络)。

说明 当该参数值为VPC时,您还需要配置VpcId参数和VSwitchId参数。
VpcId String vpc-bp175iuvg8nxqraf2****

专有网络(VPC)ID。

说明NetworkType参数值为VPC时,需要配置该参数。
VSwitchId String vsw-bp1gzt31twhlo0sa5****

虚拟交换机ID。

说明NetworkType参数值为VPC时,需要配置该参数。
SrcDBInstanceId String dds-bp1ee12ad351****

源实例ID。

说明 只有调用本接口用于克隆实例时需要配置该参数,同时需要配置BackupIdRestoreTime参数。
BackupId String 32994****

备份集ID。

说明
  • 只有调用本接口用于克隆实例时需要配置该参数,同时需要配置SrcDBInstanceId参数。
  • 您可以通过调用DescribeBackups接口查询备份集ID。
RestoreTime String 2019-03-13T12:11:14Z

克隆实例时所恢复的时间点,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

说明
  • 只有调用本接口用于克隆实例时需要配置该参数,同时需要配置SrcDBInstanceIdBackupId参数。
  • 支持选择7天内的任一时间点进行克隆。
BusinessInfo String {“ActivityId":"000000000"}

附加参数,业务信息。

AutoRenew String true

设置实例是否自动续费,取值如下:

  • true:自动续费。
  • false:不自动续费,即手动续费。

默认为 false(手动续费)。

说明ChargeType参数值为PrePaid时,需要配置该参数。
DatabaseNames String mongodbtest

数据库名。

说明 调用本接口用于克隆实例操作时,通过配置该参数指定需要克隆的数据库,如果不配置该参数,则克隆实例的所有数据库。
CouponNo String youhuiquan_promotion_option_id_for_blank

优惠码,默认为:youhuiquan_promotion_option_id_for_blank

StorageEngine String WiredTiger

实例的存储引擎。取值如下:

  • WiredTiger
  • RocksDB
  • TerarkDB

默认值为WiredTiger

  • 调用本接口用于克隆实例时,该值必须与源实例保持一致。
  • 关于存储引擎与版本的选择约束请参见版本与存储引擎
ReplicationFactor String 3

副本集节点个数。取值为357,默认值为3

ReadonlyReplicas String 1

创建只读节点的个数,取值范围为1~5

说明 默认不创建只读节点。
ResourceGroupId String rg-acfmyiu4ekp****

资源组ID。

ClusterId String dhg-2x7*************

专属集群ID。您需要在专属集群中创建MongoDB实例时,请执行以下操作:

1. 登录专属集群控制台

2. 创建数据库引擎为MongoDB的专属集群。

3. 在创建的集群中添加至少三台主机。

说明
  • 创建专属集群MongoDB实例的方法具体请参见创建集群
  • 该参数目前仅支持中国站。

返回数据

名称 类型 示例值 描述
RequestId String D8F1D721-6439-4257-A89C-F1E8E9C9****

请求ID。

DBInstanceId String dds-bp144a7f2db8****

实例ID。

OrderId String 21077576248****

订单ID。

示例

请求示例

http(s)://mongodb.aliyuncs.com/?Action=CreateDBInstance
&ClientToken=ETnLKlblzczshOTUbOCz****
&Engine=MongoDB
&EngineVersion=4.2
&DBInstanceClass=dds.mongo.standard
&DBInstanceStorage=10
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateDBInstanceResponse>
    <DBInstanceId>dds-bp144a7f2db8****</DBInstanceId>
    <OrderId>21077576248****</OrderId>
    <RequestId>D8F1D721-6439-4257-A89C-F1E8E9C9****</RequestId>
</CreateDBInstanceResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "DBInstanceId" : "dds-bp144a7f2db8****",
  "OrderId" : "21077576248****",
  "RequestId" : "D8F1D721-6439-4257-A89C-F1E8E9C9****"
}

错误码

HttpCode 错误码 错误信息 描述
400 InsufficientBalance Your account does not have enough balance. 余额不足,请您先充值后再试。
400 InvalidCapacity.NotFound The Capacity provided does not exist in our records. 容量配置不合法,请您检查输入的参数是否正确。
400 IdempotentParameterMismatch Request uses a client token in a previous request but is not identical to that request. 用了一个已经使用过的 ClientToken,但此次请求内容却又与上一次使用该 Token 的 request 不一样。
403 RealNameAuthenticationError Your account has not passed the real-name authentication yet. 用户未进行实名认证,请您先进行实名认证后再试。
403 IncorrectBackupSetState Current backup set state does not support operations. 备份集状态不支持此操作。

访问错误中心查看更多错误码。