调用CreateShardingDBInstance接口创建或者克隆MongoDB分片集群实例。
请确保在使用该接口前,已充分了解MongoDB产品的收费方式和价格(中国站价格,国际站价格)。
关于云数据库MongoDB实例的规格,请参见实例规格表。
如需创建副本集实例,可通过调用CreateDBInstance接口创建。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
RegionId | String | 是 | cn-hangzhou | 地域ID,您可以调用DescribeRegions查询。 |
Action | String | 是 | CreateShardingDBInstance | 系统规定参数。取值:CreateShardingDBInstance。 |
ZoneId | String | 否 | cn-hangzhou-b | 可用区ID,您可以调用DescribeRegions查询。 |
Engine | String | 是 | MongoDB | 数据库引擎,取值:MongoDB。 |
EngineVersion | String | 是 | 4.0 | 数据库版本号,取值:
说明
|
DBInstanceDescription | String | 否 | 分片集群_dtstest1 | 实例名称,命名规则如下:
|
SecurityIPList | String | 否 | 10.23.12.24/24 |
说明 %和0.0.0.0/0表示任何IP地址都可以访问实例的数据库,属于高危设置,请谨慎设置。
|
AccountPassword | String | 否 | Alitest!159 | root账号的密码,密码规则如下:
|
ChargeType | String | 否 | PrePaid | 实例的付费类型,取值:
默认付费类型为PostPaid(按量付费)。
说明 当本参数配置
PrePaid时,还需要配置
Period参数。
|
Period | Integer | 否 | 1 | 实例的购买时长,单位为月。取值范围为:1~9,12,24,36。
说明 当
ChargeType参数配置为
PrePaid时,该参数可用且必须配置。
|
NetworkType | String | 否 | VPC | 实例的网络类型。
默认为Classic(经典网络)。
说明 当本参数配置为
VPC时,还需要配置
VpcId参数和
VSwitchId参数。
|
VpcId | String | 是 | vpc-bp1n3i15v90el48nx**** | 专有网络(VPC)ID。
说明 当
NetworkType参数配置为
VPC时,该参数可用。
|
VSwitchId | String | 是 | vsw-bp1vj604nj5a9zz74**** | 虚拟交换机ID。
说明 当
NetworkType参数配置为
VPC时,该参数可用。
|
SrcDBInstanceId | String | 否 | dds-bp11483712c1**** | 源实例ID,只有调用本接口用于克隆实例时需要配置该参数,同时还需要配置RestoreTime参数。 |
RestoreTime | String | 否 | 2019-03-08T02:30:25Z | 克隆实例时所恢复的时间点,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 只有调用本接口用于克隆实例时需要配置该参数,同时还需要配置SrcDBInstanceId参数。
说明 支持选择7天内的任一时间点进行克隆。
|
ClientToken | String | 否 | ETnLKlblzczshOTUbOCz**** | 用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。 |
StorageEngine | String | 否 | WiredTiger | 实例使用的存储引擎,取值为WiredTiger,RocksDB,TerarkDB,默认值为WiredTiger。
说明
|
AutoRenew | String | 否 | true | 设置实例是否自动续费,取值:
默认为手动续费。
说明 当
ChargeType参数配置为
PrePaid时,该参数可用。
|
ProtocolType | String | 否 | mongodb | 访问协议的类型。取值:
|
Mongos.N.Class | String | 否 | dds.mongos.standard | Mongos节点的规格,取值详情请参见实例规格表。取值范围:2~32。 参数名中的N代表的是传入第几个Mongos节点的规格,例如:Mongos.2.Class表示传入第二个Mongos节点规格。 |
ReplicaSet.N.Class | String | 否 | dds.shard.standard | Shard节点的规格,取值详情请参见实例规格表。取值范围:2~32。 参数名中的N代表的是传入第几个Shard节点的规格,例如:ReplicaSet.2.Class表示传入第二个Shard节点规格。 |
ReplicaSet.N.Storage | Integer | 否 | 20 | Shard节点的存储空间。具体取值受实例规格约束,详情请参见实例规格表。
参数名中的N代表的是传入第几个Shard节点的存储空间,例如:ReplicaSet.2.Storage表示传入第二个Shard节点的存储空间。 |
ReplicaSet.N.ReadonlyReplicas | Integer | 否 | 5 | 设置Shard节点的只读节点个数。取值范围:0~5。默认为0。 参数名中的N代表的是设置第几个Shard节点中的只读节点个数。例如:ReplicaSet.2.ReadonlyReplicas表示设置第二个Shard节点的只读节点个数。
说明 当前仅中国站支持本参数。
|
ConfigServer.N.Class | String | 否 | dds.cs.mid | CongfigServer的规格,取值为dds.cs.mid。
说明 规格固定为1核2GB,数量固定为1个,例如:传入
ConfigServer.1.Class参数,取值为
dds.cs.mid。
|
ConfigServer.N.Storage | Integer | 否 | 20 | CongfigServer的存储空间,取值为20。
说明 存储空间取值固定为20 GB。配置
ConfigServer.1.Storage参数,取值为
20。
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | D8F1D721-6439-4257-A89C-F1E8E9C9**** | 请求ID。 |
DBInstanceId | String | dds-bp114f14849d**** | 实例ID。 |
OrderId | String | 21010996721**** | 订单ID。 |
示例
请求示例
http(s)://mongodb.aliyuncs.com/?Action=CreateShardingDBInstance &Engine=MongoDB &EngineVersion=4.0 &AccountPassword=Alitest!159 &ZoneId=cn-hangzhou-b &ClientToken=ETnLKlblzczshOTUbOCz**** &<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK Content-Type:application/xml <CreateShardingDBInstanceResponse> <DBInstanceId>dds-bp114f14849d****</DBInstanceId> <OrderId>21010996721****</OrderId> <RequestId>D8F1D721-6439-4257-A89C-F1E8E9C9****</RequestId> </CreateShardingDBInstanceResponse>
JSON
格式
HTTP/1.1 200 OK Content-Type:application/json { "DBInstanceId" : "dds-bp114f14849d****", "OrderId" : "21010996721****", "RequestId" : "D8F1D721-6439-4257-A89C-F1E8E9C9****" }
错误码
访问错误中心查看更多错误码。