调用CreateDBInstance接口创建或克隆云数据库MongoDB副本集实例。
请确保在使用该接口前,已充分了解云数据库MongoDB产品的收费方式和价格。
关于云数据库MongoDB实例的规格,请参见实例规格表。
如需创建分片集群实例,您可以通过调用CreateShardingDBInstance接口创建。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateDBInstance |
系统规定参数。取值:CreateDBInstance。 |
RegionId | String | 是 | cn-hangzhou |
地域ID,您可以通过调用DescribeRegions接口查询地域ID。 |
ClientToken | String | 否 | ETnLKlblzczshOTUbOCz**** |
用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。 |
ZoneId | String | 否 | cn-hangzhou-b |
可用区ID,您可以通过调用DescribeRegions接口查询可用区ID。 |
Engine | String | 是 | MongoDB |
数据库引擎,取值:MongoDB。 |
EngineVersion | String | 是 | 4.2 |
数据库版本号,取值:
说明 调用本接口克隆实例时,该参数需和源实例保持一致。
|
DBInstanceClass | String | 是 | dds.mongo.standard |
实例规格,您可以通过调用DescribeAvailableResource接口查询实例规格。 |
DBInstanceStorage | Integer | 是 | 10 |
实例存储空间,具体取值受实例规格约束,详情请参见副本集实例规格表。 |
DBInstanceDescription | String | 否 | 测试数据库1 |
实例名称,取值说明:
|
SecurityIPList | String | 否 | 10.23.XX.XX |
实例的IP白名单,以英文逗号隔开,不可重复,最多1000个IP。 说明
|
AccountPassword | String | 否 | Alitest!159 |
root账号的密码,取值说明:
|
ChargeType | String | 否 | PrePaid |
实例的付费类型,取值说明:
说明 当该参数的值为PrePaid时,您还需要配置Period参数。
|
Period | Integer | 否 | 1 |
实例的购买时长,单位为月。取值范围为:1~9,12,24,36。 说明 当ChargeType参数值为PrePaid时,该参数才生效且为必填参数。
|
NetworkType | String | 否 | VPC |
实例的网络类型,取值说明:
说明 当该参数值为VPC时,您还需要配置VpcId参数和VSwitchId参数。
|
VpcId | String | 是 | vpc-bp175iuvg8nxqraf2**** |
专有网络(VPC)ID。 |
VSwitchId | String | 是 | vsw-bp1gzt31twhlo0sa5**** |
虚拟交换机ID。 |
SrcDBInstanceId | String | 否 | dds-bp1ee12ad351**** |
源实例ID。 说明 只有调用本接口克隆实例时,您需要配置该参数,同时还需要配置BackupId或RestoreTime参数。
|
BackupId | String | 否 | 32994**** |
备份集ID。 说明
|
RestoreTime | String | 否 | 2019-03-13T12:11:14Z |
克隆实例时所恢复的时间点,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 说明
|
BusinessInfo | String | 否 | {“ActivityId":"000000000"} |
附加参数,业务信息。 |
AutoRenew | String | 否 | true |
实例是否自动续费,取值说明:
说明 当ChargeType参数值为PrePaid时,该参数才生效且为可选参数。
|
DatabaseNames | String | 否 | mongodbtest |
数据库名。 说明 调用本接口克隆实例时,您可以通过配置该参数指定需要克隆的数据库,如果不配置该参数,则克隆实例的所有数据库。
|
CouponNo | String | 否 | youhuiquan_promotion_option_id_for_blank |
优惠码,默认为: |
StorageEngine | String | 否 | WiredTiger |
实例的存储引擎,取值:
说明
|
ReplicationFactor | String | 否 | 3 |
副本集节点个数,取值:
|
ReadonlyReplicas | String | 否 | 1 |
创建只读节点的个数,取值范围为1~5。 说明 默认不创建只读节点。
|
ResourceGroupId | String | 否 | rg-acfmyiu4ekp**** |
资源组ID。 |
ClusterId | String | 否 | dhg-2x7************* |
专属集群ID。您需要在专属集群中创建MongoDB实例时,请执行以下操作: 1. 登录专属集群控制台。 2. 创建数据库引擎为MongoDB的专属集群。 3. 在创建的集群中添加至少三台主机。 说明
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | D8F1D721-6439-4257-A89C-F1E8E9C9**** |
请求ID。 |
DBInstanceId | String | dds-bp144a7f2db8**** |
实例ID。 |
OrderId | String | 21077576248**** |
订单ID。 |
示例
请求示例
http(s)://mongodb.aliyuncs.com/?Action=CreateDBInstance
&RegionId=cn-hangzhou
&ClientToken=ETnLKlblzczshOTUbOCz****
&ZoneId=cn-hangzhou-b
&Engine=MongoDB
&EngineVersion=4.2
&DBInstanceClass=dds.mongo.standard
&DBInstanceStorage=10
&DBInstanceDescription=测试数据库1
&SecurityIPList=10.23.XX.XX
&AccountPassword=Alitest!159
&ChargeType=PrePaid
&Period=1
&NetworkType=VPC
&VpcId=vpc-bp175iuvg8nxqraf2****
&VSwitchId=vsw-bp1gzt31twhlo0sa5****
&SrcDBInstanceId=dds-bp1ee12ad351****
&BackupId=32994****
&RestoreTime=2019-03-13T12:11:14Z
&BusinessInfo={“ActivityId":"000000000"}
&AutoRenew=true
&DatabaseNames=mongodbtest
&CouponNo=youhuiquan_promotion_option_id_for_blank
&StorageEngine=WiredTiger
&ReplicationFactor=3
&ReadonlyReplicas=1
&ResourceGroupId=rg-acfmyiu4ekp****
&ClusterId=dhg-2x7*************
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateDBInstanceResponse>
<RequestId>D8F1D721-6439-4257-A89C-F1E8E9C9****</RequestId>
<DBInstanceId>dds-bp144a7f2db8****</DBInstanceId>
<OrderId>21077576248****</OrderId>
</CreateDBInstanceResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "D8F1D721-6439-4257-A89C-F1E8E9C9****",
"DBInstanceId" : "dds-bp144a7f2db8****",
"OrderId" : "21077576248****"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InsufficientBalance | Your account does not have enough balance. | 支付失败,您可以添加其他支付方式,也可以充值后重试。 |
400 | InvalidCapacity.NotFound | The Capacity provided does not exist in our records. | 实例的存储容量配置错误,请设置为有效范围内的值,单位为MB。 |
400 | IdempotentParameterMismatch | Request uses a client token in a previous request but is not identical to that request. | ClientToken参数值已被使用,请输入未使用过的ClientToken参数值。ClientToken由客户端生成,需保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。 |
403 | RealNameAuthenticationError | Your account has not passed the real-name authentication yet. | 阿里云账号未进行实名认证,请进行实名认证后重试。 |
403 | IncorrectBackupSetState | Current backup set state does not support operations. | 当前最新备份集未就绪,请稍后重试。 |
访问错误中心查看更多错误码。