调用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-g |
可用区ID,您可以通过调用DescribeRegions接口查询可用区ID。 |
| Engine | String | 是 | MongoDB |
数据库引擎,固定取值:MongoDB。 |
| EngineVersion | String | 是 | 4.4 |
数据库版本号,取值:
说明 调用本接口克隆实例时,该参数值需和源实例保持一致。
|
| DBInstanceClass | String | 是 | dds.mongo.standard |
实例规格,您可以通过调用DescribeAvailableResource接口查询实例规格。 |
| DBInstanceStorage | Integer | 是 | 10 |
实例存储空间,单位:GB。 具体取值受实例规格约束,详情请参见副本集实例规格表。 |
| DBInstanceDescription | String | 否 | test |
实例名称,取值说明:
|
| SecurityIPList | String | 否 | 192.168.xx.xx,192.168.xx.xx |
实例的IP白名单,多个IP地址请用英文逗号(,)分隔,不可重复。支持如下三种格式:
|
| AccountPassword | String | 否 | 123456Aa |
root账号的密码,取值说明:
|
| ChargeType | String | 否 | PrePaid |
实例的付费类型,取值说明:
说明 当该参数的值为PrePaid时,您还需要配置Period参数。
|
| Period | Integer | 否 | 1 |
实例的购买时长,单位为月。 取值范围:1~9(整数)、12、24、36、60。 说明 当ChargeType参数值为PrePaid时,该参数可用且为必填参数。
|
| NetworkType | String | 否 | VPC |
实例的网络类型,取值说明: VPC:专有网络。 |
| VpcId | String | 是 | vpc-bp175iuvg8nxqraf2**** |
专有网络(VPC)ID。 |
| VSwitchId | String | 是 | vsw-bp1gzt31twhlo0sa5**** |
虚拟交换机ID。 |
| SrcDBInstanceId | String | 否 | dds-bp1ee12ad351**** |
源实例ID。 说明 只有调用本接口克隆实例时,您需要配置该参数,同时还需要配置BackupId或RestoreTime参数。
|
| BackupId | String | 否 | 32994**** |
备份点ID,您可以通过调用DescribeBackups接口查询备份点ID。 说明 只有调用本接口按备份点克隆实例时,您需要配置该参数,同时还需要配置SrcDBInstanceId参数。
|
| RestoreTime | String | 否 | 2022-03-13T12:11:14Z |
选择要恢复的时间点,您可以配置7天内的任意时间点。格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 说明 只有调用本接口按时间点克隆实例时,您需要配置该参数,同时还需要配置SrcDBInstanceId参数。
|
| 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 | 否 | 0 |
副本集实例的只读节点数,取值范围:0~5(整数),默认值为0。 |
| ResourceGroupId | String | 否 | rg-acfmyiu4ekp**** |
资源组ID。 |
| ClusterId | String | 否 | dhg-2x78**** |
专属集群ID。 |
| StorageType | String | 否 | cloud_essd1 |
存储类型,取值说明:
|
| SecondaryZoneId | String | 否 | cn-hangzhou-h |
配置从节点(Secondary节点)所在的可用区,实现多可用区部署。取值说明:
|
| HiddenZoneId | String | 否 | cn-hangzhou-i |
配置隐藏节点(Hidden节点)所在的可用区,实现多可用区部署。取值说明:
|
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| 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-g
&Engine=MongoDB
&EngineVersion=4.4
&DBInstanceClass=dds.mongo.standard
&DBInstanceStorage=10
&DBInstanceDescription=test
&SecurityIPList=192.168.xx.xx,192.168.xx.xx
&AccountPassword=123456Aa
&ChargeType=PrePaid
&Period=1
&NetworkType=VPC
&VpcId=vpc-bp175iuvg8nxqraf2****
&VSwitchId=vsw-bp1gzt31twhlo0sa5****
&BusinessInfo={“ActivityId":"000000000"}
&AutoRenew=true
&CouponNo=youhuiquan_promotion_option_id_for_blank
&StorageEngine=WiredTiger
&ReplicationFactor=3
&ReadonlyReplicas=0
&StorageType=cloud_essd1
&公共请求参数
正常返回示例
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 | InvalidDBInstanceDescription.Malformed | Specified parameter DBInstanceDescription is not valid. | 节点名称不合法 |
| 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. | 当前最新备份集未就绪,请稍后重试。 |
访问错误中心查看更多错误码。