调用CreateShardingDBInstance接口创建或者克隆云数据库MongoDB分片集群实例。
- 请确保在使用该接口前,已充分了解云数据库MongoDB的收费方式和价格。
- 关于云数据库MongoDB实例的规格,请参见实例规格表。
- 如果需要创建单节点实例和副本集实例,您可以通过调用CreateDBInstance接口创建。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| RegionId | String | 是 | cn-hangzhou |
地域ID,您可以通过调用DescribeRegions接口查询地域ID。 |
| Action | String | 是 | CreateShardingDBInstance |
系统规定参数。取值:CreateShardingDBInstance。 |
| ZoneId | String | 否 | cn-hangzhou-g |
可用区ID,您可以通过调用DescribeRegions接口查询可用区ID。 |
| Engine | String | 是 | MongoDB |
数据库引擎。固定取值:MongoDB。 |
| EngineVersion | String | 是 | 4.4 |
数据库版本号,取值:
|
| 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-bp1n3i15v90el48nx**** |
专有网络(VPC)ID。 |
| VSwitchId | String | 是 | vsw-bp1vj604nj5a9zz74**** |
虚拟交换机ID。 |
| SrcDBInstanceId | String | 否 | dds-bp11483712c1**** |
源实例ID。 说明 只有调用本接口克隆实例时,您需要配置该参数,同时还需要配置RestoreTime参数。
|
| RestoreTime | String | 否 | 2022-03-08T02:30:25Z |
选择要恢复的时间点,您可以配置7天内的任意时间点。格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 说明 只有调用本接口克隆实例时,您需要配置该参数,同时还需要配置SrcDBInstanceId参数。
|
| ClientToken | String | 否 | ETnLKlblzczshOTUbOCz**** |
用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。 |
| StorageEngine | String | 否 | WiredTiger |
实例的存储引擎,取值:
|
| AutoRenew | String | 否 | true |
实例是否自动续费,取值说明:
说明 当ChargeType参数值为PrePaid时,该参数可用且为可选参数。
|
| ProtocolType | String | 否 | mongodb |
访问协议的类型,取值说明:
|
| Mongos.N.Class | String | 是 | mdb.shard.2x.xlarge.d |
Mongos节点的规格,取值详情请参见分片集群实例规格表。 说明
|
| ReplicaSet.N.Class | String | 是 | dds.shard.standard |
Shard节点的规格,取值详情请参见分片集群实例规格表。 说明
|
| ReplicaSet.N.Storage | Integer | 是 | 10 |
Shard节点的存储空间,单位为GB。 说明
|
| ReplicaSet.N.ReadonlyReplicas | Integer | 否 | 0 |
设置Shard节点的只读节点个数。 取值范围:0~5(整数),默认值为0。 说明 参数名中的N代表设置第几个Shard节点中的只读节点个数。例如,ReplicaSet.2.ReadonlyReplicas表示设置第二个Shard节点的只读节点个数。
|
| ConfigServer.N.Class | String | 是 | mdb.shard.2x.xlarge.d |
CongfigServer的规格,取值说明:
|
| ConfigServer.N.Storage | Integer | 是 | 20 |
CongfigServer的存储空间,单位为GB。 说明 具体取值受实例规格约束,取值详情请参见分片集群实例规格表。
|
| ResourceGroupId | String | 否 | rg-acfmyiu4ekp**** |
资源组ID,资源组详情请参见查看资源组基本信息。 |
| SecondaryZoneId | String | 否 | cn-hangzhou-h |
配置备可用区1,实现多可用区部署。取值说明:
|
| HiddenZoneId | String | 否 | cn-hangzhou-i |
配置备可用区2,实现多可用区部署。取值说明:
|
| StorageType | String | 否 | cloud_essd1 |
存储类型,取值说明:
说明
|
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | D8F1D721-6439-4257-A89C-F1E8E9C9**** |
请求ID。 |
| DBInstanceId | String | dds-bp114f14849d**** |
实例ID。 |
| OrderId | String | 21010996721**** |
订单ID。 |
示例
请求示例
http(s)://mongodb.aliyuncs.com/?RegionId=cn-hangzhou
&Action=CreateShardingDBInstance
&ZoneId=cn-hangzhou-g
&Engine=MongoDB
&EngineVersion=4.4
&DBInstanceDescription=test
&SecurityIPList=192.168.xx.xx,192.168.xx.xx
&AccountPassword=123456Aa
&ChargeType=PrePaid
&Period=1
&NetworkType=VPC
&VpcId=vpc-bp1n3i15v90el48nx****
&VSwitchId=vsw-bp1vj604nj5a9zz74****
&SrcDBInstanceId=dds-bp11483712c1****
&RestoreTime=2022-03-08T02:30:25Z
&ClientToken=ETnLKlblzczshOTUbOCz****
&StorageEngine=WiredTiger
&AutoRenew=true
&ProtocolType=mongodb
&Mongos=[{"Class":"mdb.shard.2x.xlarge.d"}]
&ReplicaSet=[{"Class":"dds.shard.standard","Storage":10,"ReadonlyReplicas":0}]
&ConfigServer=[{"Class":"mdb.shard.2x.xlarge.d","Storage":20}]
&StorageType=cloud_essd1
&公共请求参数
正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateShardingDBInstanceResponse>
<RequestId>D8F1D721-6439-4257-A89C-F1E8E9C9****</RequestId>
<DBInstanceId>dds-bp114f14849d****</DBInstanceId>
<OrderId>21010996721****</OrderId>
</CreateShardingDBInstanceResponse>
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "D8F1D721-6439-4257-A89C-F1E8E9C9****",
"DBInstanceId" : "dds-bp114f14849d****",
"OrderId" : "21010996721****"
}
错误码
访问错误中心查看更多错误码。