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

Before you call this operation, make sure that you understand the billing methods and pricing of ApsaraDB for MongoDB.

For more information about the instance types in ApsaraDB for MongoDB, see Instance types.

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 to CreateShardingDBInstance.

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.
EngineVersion String Yes 4.0

The engine version of the database. Valid values: 3.4, 4.0, and 4.2.

Note
  • For more information about the limits on database versions and storage engines, see MongoDB versions and storage engines.
  • To call this operation to clone an instance, set this value to the engine version number of the source instance.
Engine String Yes MongoDB

The database engine. Set the value to MongoDB.

RegionId String Yes cn-hangzhou

The ID of the region where the instance is deployed. You can call the DescribeRegions operation to query available regions where the instance can be created.

ZoneId String No cn-hangzhou-b

The ID of the zone where the instance is deployed. You can call the DescribeRegions operation to query available zones where the instance can be created.

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

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

N specifies the serial number of the mongos for which the specification is specified. For example,

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

The specification of a shard. For more information, see Instance types.

N specifies the serial number of the shard for which the specification is specified. For example,

  • ReplicaSet.1.Class specifies the specification of the first shard.
  • ReplicaSet.2.Class specifies the specification of the second shard.
Note You can specify the specifications of 2 to 32 shards.
ReplicaSet.N.Storage Integer No 20

The storage space of the shard.

  • Valid values: 10 to 2000. Unit: GB.
  • The value must be a multiple of 10 GB.
Note The values that can be specified for this parameter are subject to the instance specifications. For more information, see Instance types.

N specifies the serial number 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 specifies the storage space of the second shard.
ConfigServer.N.Class String No dds.cs.mid

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

Note Set the specification to one CPU core and 2 GB. You can specify the specification of only one config server. For example, set the ConfigServer.1.Class parameter to dds.cs.mid.
ConfigServer.N.Storage Integer No 20

The storage space of a config server. Set the value to 20.

Note You can set this parameter to 20 GB only. For example, set the 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 added.
  • You can enter IP addresses such as 10.23.12.24 and Classless Inter-Domain Routing (CIDR) blocks such as 10.23.12.24/24. /24 indicates the length of the CIDR block prefix. The prefix can be 1 to 32 bits in length. You can also enter the percent sign (%) or 0.0.0.0/0.
Note If you enter the percent sign (%) or 0.0.0.0/0, all IP addresses can access the instance. This may introduce security risks to the instance.
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 set 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 valid and required only if you set the ChargeType parameter to PrePaid.
NetworkType String No VPC

The network type of the instance. Default value: CLASSIC.

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

The ID of the virtual private cloud (VPC).

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

The ID of the VSwitch.

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

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

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

The target time point of the clone operation. After you set this parameter, the data of the source instance at the specified time point is used to create an instance. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

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

Note You can set this parameter to any time point in the last seven days.
ClientToken String No ETnLKlblzczshOTUbOCzxxxxxxxxxx

The client token that is used to ensure the idempotence 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, and TerarkDB. Default value: WiredTiger. For more information about the limits on database versions and storage engines, see MongoDB versions and storage engines.

Note To call this operation to clone an instance, set this value to the engine version number of the source instance.
AutoRenew String No true

Specifies whether to enable automatic renewal for the instance. Valid values:

  • true: enables automatic renewal.
  • false: disables automatic renewal. You must renew the instance manually.

Default value: false.

Note This parameter is valid only if you set the ChargeType parameter to PrePaid.
ProtocolType String No mongodb

The type of the access protocol. Valid values:

  • mongodb: the MongoDB protocol
  • dynamodb: the DynamoDB protocol

Response parameters

Parameter Type Example Description
DBInstanceId String dds-bpxxxxxxxx

The ID of the instance.

OrderId String 2033xxxxxxxxxxxx

The ID of the order.

RequestId String D8F1D721-6439-4257-A89C-F1E8E9C9623D

The ID of the request.

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 parameters>

Sample success responses

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.