You can call this operation to create or clone ApsaraDB for MongoDB sharded cluster instances.

Make sure that you fully understand the billing methods and pricing of ApsaraDB for MongoDB before using this API.

For more information about the specifications of ApsaraDB for MongoDB instances, see Instance specifications.

To create replica set instances, you can call CreateDBInstance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateShardingDBInstance

The operation that you want to perform. Set the value toCreateShardingDBInstance.

AccountPassword String Yes Alitest! 159

The password of the root account.

  • The password must contain at least three types of the following characters: uppercase letters, lowercase letters, digits, and special characters. Special characters include ! # $ % ^ & * ( ) _ + - =
  • The password must be 8 to 32 characters in length.
Engine String Yes MongoDB

The database engine. Valid value:MongoDB.

EngineVersion String Yes 4.0

The version number of the database. Valid values: 3.2, 3.4 or 4.0.

Note
  • For more information about the limits on database versions and storage engines, seeVersions and storage engines.
  • When calling this operation to clone instances, ensure that this value is the same as the engine version number of its source instances.
RegionId String Yes cn-hangzhou

The region ID. You can call the DescribeRegions operation to query available regions.

ZoneId String No cn-hangzhou-b

The ID of the zone. You can call the DescribeRegions operation to query available zones.

Mongos.N.Class String No dds.mongos.standard

The specification of mongos N. For more information, see Instance specifications.

N indicates the sequence of the mongos for which a specification is specified. For example,

  • Mongos.1.Class specifies the first Mongos node specifications.
  • Mongos.2.Class specifies the node specifications the second Mongos.
Note You can specify 2 to 32 mongos.
ReplicaSet.N.Class String No dds.shard.standard

The specification of shard N. For more information about the value, see Instance specifications.

N indicates the sequence of the shard for which a specification is specified. For example,

  • ReplicaSet.1.Class the node specifications the first Shard.
  • ReplicaSet.2.Class the node specifications the second Shard.
Note You can specify 2 to 32 shards.
ReplicaSet.N.Storage Integer Optional 20

The storage space of shard N.

  • Valid values: 10 to 2000. Unit: GB.
  • You can only specify this value in 10 GB increments.
Note The values that can be specified for this parameter are dependent on the instance specifications. For more information, seeInstance specifications.

N indicates the sequence of the shard for which storage space is specified. For example,

  • ReplicaSet.1.Storage specifies the storage space of the first Shard.
  • ReplicaSet.2.Storage the storage space of the second Shard.
ConfigServer.N.Class String No dds.cs.mid

The specification of config server N. Valid value: dds.cs.mid.

Note The specifications of the instance are fixed at 1 core and 2GB memory. The minimum specification is 1. For example: set the value of ConfigServer.1.Class parameter to dds.cs.mid.
ConfigServer.N.Storage Integer Optional 20

The storage space of config server N. Valid value: 20.

Note This parameter can be specified to only 20 GB. For example, set the alue of ConfigServer.1.Storage parameter to 20.
DBInstanceDescription String No Test database 1

The name of the instance. It must be 2 to 256 characters in length. The name must start with a letter, and can contain digits, letters, underscores (_), and hyphens (-).

SecurityIPList String No 10.23.12.24/24
  • The whitelist that contains the IP addresses that are allowed to access the instance. Separate multiple IP addresses with commas (,). Each IP address must be unique. A maximum of 1,000 IP addresses can be set.
  • Supported formats include: prefix, 0.0.0.0/0,10.23.12.24, and 10.23.12.24/24. You can use the IP address format (10.23.12.24/24), or CIDR format (10.23.12.24/24), where /24 indicates the length of the IP address prefix. The IP address prefix can be 1 to 32 bits.
Note % and 0.0.0.0/0 indicate that any IP address can access the database. We do not recommend including these values in your whitelist as they expose your database to security risks.
ChargeType String No PrePaid

The billing method of the instance. Valid values:

  • PostPaid: pay-as-you-go
  • PrePaid: Subscription

Default value: Pay-As-You-Go.

Note If you specify this parameter to PrePaid, you must also specify the Period parameter.
Period Integer No 1

The subscription period of the instance. Unit: months. Valid values: 1 to 9,12,24, and 36.

Note This parameter is only valid when you specify the ChargeType parameter to PrePaid.
NetworkType String No VPC

The network type of the instance. Valid values: The classic network is specified by default when you create the instance.

  • CLASSIC
  • VPC
Note If you specify this parameter to VPC, you must also specify the VpcId parameter and the VSwitchId parameter.
VpcId String No vpc-bpxxxxxxxx

The ID of the VPC.

Note This parameter is only valid when you specify the NetworkType parameter to VPC.
VSwitchId String No vsw-bpxxxxxxxx

The ID of the VSwitch.

Note This parameter is only valid when you specify the NetworkType parameter to VPC.
SrcDBInstanceId String No dds-bpxxxxxxxx

The ID of the source instance. This parameter can only be specified when this operation is called to clone instances. You must also specify the RestoreTime parameter.

RestoreTime String No 2019-03-08T02:30:25Z

The time to restore the cloned instance to. The format is: yyyy-MM-dd T HH:mm:ss z(UTC time).

This parameter can only be specified when this operation is called to clone instances. You must also specify the SrcDBInstanceId parameter.

Note You can clone instances to any restore time in the past seven days.
ClientToken String No ETnLKlblzczshOTUbOCzxxxxxxxxxx

The client token that is used to ensure the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.

StorageEngine String No WiredTiger

The storage engine used by the instance. Valid values: WiredTiger, RocksDB, TerarkDB. Default value: WiredTiger. For more information about the limits on database versions and storage engines, see version and storage engine.

Note When calling this operation to clone instances, ensure that this value is the same as the engine version number of its source instances.
AutoRenew String No true

Indicates whether automatic renewal is enabled for the instance. Valid values:

  • true: Automatic renewal is enabled.
  • false: Automatic renewal is not enabled. You must renew the instance manually.

Default value: false.

Note This parameter is only valid when you specify the ChargeType parameter to PrePaid.

Response parameters

Prameter Type Sample response Description
RequestId String D8F1D721-6439-4257-A89C-F1E8E9C9623D

The ID of the request.

OrderId String 2033xxxxxxxxxxxx

The ID of the order.

DBInstanceId String dds-bpxxxxxxxx

The ID of the instance.

Examples

Sample requests

http(s)://mongodb.aliyuncs.com/? Action=CreateShardingDBInstance
&Engine=MongoDB
&EngineVersion=4.0
&AccountPassword=Alitest! 159
&ZoneId=cn-hangzhou-b
&ClientToken=ETnLKlblzczshOTUbOCzxxxxxxxxxx
&<Common request parameter>

Sample success response

XML format

<CreateDBInstanceResponse>
      <DBInstanceId>dds-bpxxxxxxxx</DBInstanceId>
      <OrderId>2033xxxxxxxxxxxx</OrderId>
      <RequestId>D8F1D721-6439-4257-A89C-F1E8E9C9623D</RequestId>
</CreateDBInstanceResponse>

JSON format

{
    "DBInstanceId": "dds-bpxxxxxxxx",
    "OrderId": "2033xxxxxxxxxxxx",
    "RequestId": "D8F1D721-6439-4257-A89C-F1E8E9C9623D"
}

Error codes.

For a list of error codes, visit the API Error Center.