ApsaraDB for MongoDB sharded cluster instances are suitable for scenarios in which a large number of high concurrency read and write operations are involved. This topic describes how to create a sharded cluster instance in the ApsaraDB for MongoDB console.

Prerequisites

An Alibaba Cloud account is created. For more information, see Sign up with Alibaba Cloud.

Precautions

If your application is deployed on an Elastic Compute Service (ECS) instance, make sure that your ApsaraDB for MongoDB instance and ECS instance meet the following requirements to ensure network connectivity: For more information about how to view ECS instance information, see View instance information.
  • Your ApsaraDB for MongoDB instance and ECS instance are deployed in the same region, and preferably belong to the same zone. This reduces network latency.
  • Your ApsaraDB for MongoDB instance and ECS instance use the same network type.
    Note
    • VPC is recommended because VPC provides higher security.
    • If the network type is VPC, you must ensure that they use the same VPC ID.
    • If you want to use VPC, but the network type of the ECS instance is classic network, you can change the network type of the ECS instance to VPC. For more information, see Migrate ECS instances from the classic network to a VPC.

Limits

  • ApsaraDB for MongoDB instances that run MongoDB 3.4, 4.0, or 4.2 can be created only in the following regions and zones:
    • China (Hangzhou): Hangzhou Zone G, Zone H, Zone I, Zone J, and Zone K
    • China (Shanghai): Shanghai Zone B, Zone D, Zone G, and Zone L
    • China (Qingdao): Qingdao Zone B and Zone C
    • China (Beijing): Beijing Zone E, Zone F, Zone H, Zone K, and Zone L
    • China (Zhangjiakou): Zhangjiakou Zone A, Zone B, and Zone C
    • China (Hohhot): Hohhot Zone A and Zone B
    • China (Ulanqab): Ulanqab Zone A, Zone B, and Zone C
    • China (Shenzhen): Shenzhen Zone A, Zone C, Zone D, Zone E, Zone F, and Zones (C + D + E)
    • China (Heyuan): Heyuan Zone A and Zone B
    • China (Guangzhou): Guangzhou Zone A
    • China (Chengdu): Chengdu Zone A and Zone B
    • China (Hong Kong): Hongkong Zone B, Zone C, Zone D, and Zones (B + C + D)
    • Singapore (Singapore): Singapore Zone A, Zone B, Zone C, and Zones (A + B + C)
    • Australia (Sydney): Sydney Zone A and Zone B
    • Malaysia (Kuala Lumpur): Kuala Lumpur Zone A and Zone B
    • Indonesia (Jakarta): Jakarta Zone A, Zone B, and Zone C
    • Philippines (Manila): Manila Zone A
    • Japan (Tokyo): Tokyo Zone A and Zone B
    • India (Mumbai): Mumbai Zone A
    • UAE (Dubai): Dubai Zone A
    • US (Silicon Valley): Silicon Valley Zone A and Zone B
    • US (Virginia): Virginia Zone A and Zone B
    • UK (London): London Zone A and Zone B
    • Germany (Frankfurt): Frankfurt Zone A, Zone B, and Zone C
  • ApsaraDB for MongoDB instances that run MongoDB 4.4 or 5.0 can be created only in the following regions and zones:
    • China (Hangzhou): Hangzhou Zone G, Zone H, and Zone I
    • China (Shanghai): Shanghai Zone B and Zone G
    • China (Qingdao): Qingdao Zone C
    • China (Beijing): Beijing Zone F and Zone H
    • China (Zhangjiakou): Zhangjiakou Zone A and Zone C
    • China (Hohhot): Hohhot Zone B
    • China (Ulanqab): Ulanqab Zone A, Zone B, and Zone C
    • China (Shenzhen): Shenzhen Zone E
    • China (Heyuan): Heyuan Zone A and Zone B
    • China (Chengdu): Chengdu Zone A and Zone B
    • China (Hong Kong): Hongkong Zone B, Zone C, and Zone D
    • Singapore (Singapore): Singapore Zone A, Zone B, and Zone C
    • Malaysia (Kuala Lumpur): Kuala Lumpur Zone B
    • Indonesia (Jakarta): Jakarta Zone A, Zone B, and Zone C
    • Thailand (Bangkok): Bangkok Zone A
    • Japan (Tokyo): Tokyo Zone A and Zone B
    • South Korea (Seoul): Seoul Zone A
    • US (Silicon Valley): Silicon Valley Zone B
    • UK (London): London Zone A and Zone B
    • US (Virginia): Virginia Zone A and Zone B
    • Germany (Frankfurt): Frankfurt Zone A, Zone B, and Zone C

Billing

An Alibaba Cloud account is created. For more information, see Sign up with Alibaba Cloud.
  • Subscription: If you purchase a subscription instance, you must pay an upfront fee for the instance.
  • Pay-as-you-go: A pay-as-you-go instance is charged per hour based on the configuration of the instance. Fees are automatically deducted from your Alibaba Cloud account.
Note For more information, see Billable items and pricing.

Procedure

  1. Log on to the ApsaraDB for MongoDB console.
  2. In the left-side navigation pane, click Sharded Cluster Instances.
  3. On the Sharded Cluster Instances page, click Create Instance.
  4. Set Product Type to Sharded Cluster (Subscription) or Sharded Cluster (Pay-as-you-go).
  5. Configure the parameters described in the following table.
    Parameter Description
    Region The region where you want to deploy the sharded cluster instance.
    Note
    • After the sharded cluster instance is created, you cannot change the region of the instance. Proceed with caution.
    • If your application is deployed on an Elastic Compute Service (ECS) instance, we recommend that you deploy the sharded cluster instance in the region where the ECS instance resides. If the sharded cluster instance and the ECS instance belong to different regions, your application cannot connect to the sharded cluster instance over an internal network.
    Zone The zone where you want to deploy the sharded cluster instance.
    Note
    • If your application is deployed on an ECS instance, we recommend that you deploy the sharded cluster instance in the zone where the ECS instance resides to reduce network latency. If the zone that you select for the sharded cluster instance is different from the zone of the ECS instance, you can migrate the sharded cluster instance to the same zone as the ECS instance after the sharded cluster instance is created. For more information, see Migrate an ApsaraDB for MongoDB instance to different zones in the same region.
    • You can select multiple zones for the sharded cluster instance to implement zone-disaster recovery. For more information, see Create a multi-zone sharded cluster instance.
    Protocol Type The protocol type of the sharded cluster instance.
    • MongoDB
    • DynamoDB
    Note For more information about the DynamoDB protocol, see Compatibility details of DynamoDB-compatible ApsaraDB for MongoDB instances.
    Engine Version The MongoDB version of the sharded cluster instance. Valid values:
    • MongoDB 5.0
    • MongoDB 4.4
    • MongoDB 4.2
    • MongoDB 4.0
    • MongoDB 3.4
    Note
    • You can select only MongoDB 4.0 for sharded cluster instances that have the DynamoDB protocol type selected.
    • When a sharded cluster instance is in the Running state, you can manually upgrade the MongoDB version of the instance. For more information, see Upgrade MongoDB versions.
    Storage Engine The storage engine of the sharded cluster instance. This value can be set only to WiredTiger.
    Storage Type The storage type of the sharded cluster instance.
    • ESSD PL1: This parameter can be set only to ESSD PL1 if the sharded cluster instance runs MongoDB 5.0 or 4.4.
    • Local SSD: This parameter can be set only to Local SSD if the sharded cluster instance runs MongoDB 4.2, 4.0, or 3.4.
    Network Type The type of network where you want to deploy the sharded cluster instance. This parameter can be set only to VPC.
    Note If your application is deployed on an ECS instance, you must make sure that the ECS instance is in a VPC. This ensures network connectivity between your application and the sharded cluster instance.
    VPC The ID of the virtual private cloud (VPC) where you want to deploy the sharded cluster instance. If no VPCs are available, you can create a VPC in the VPC console. For more information, see Create and manage a VPC.
    Note
    vSwitch The ID of the vSwitch to which the sharded cluster instance connects. If no vSwitches are available, you can create a vSwitch in the VPC console. For more information, see Create and manage a vSwitch.
    Mongos Specification The specifications of each mongos node in the sharded cluster instance. For more information about the specifications that are supported by mongos nodes, see Instance types.
    Note When the sharded cluster instance is in the Running state, you can change the configurations and quantity of mongos nodes.
    Mongos Quantity The number of mongos nodes in the sharded cluster instance. Valid values: 2 to 32.
    Note
    • By default, mongos nodes use the standalone architecture. We recommend that you specify two or more mongos nodes to ensure high availability.
    • By default, a sharded cluster instance supports a maximum of 32 mongos nodes. If your business requires more than 32 mongos nodes, submit a ticket.
    Shard Specifications The specifications of each shard node in the sharded cluster instance. For more information about the specifications that are supported by shard nodes, see Instance types.
    Note When the sharded cluster instance is in the Running state, you can change the configurations and quantity of shard nodes.
    Shard Storage The storage capacity of each shard node in the sharded cluster instance.
    Note
    • This parameter specifies the storage capacity of each node rather than the sum of the storage capacity of all nodes.
    • The storage capacity is used to store the data, system, and log files.
    Shard Read-only Nodes The number of read-only nodes in a shard node of the sharded cluster instance. Valid values: 0 to 5. For more information about read-only nodes, see Read-only nodes.
    Shard Quantity The number of shard nodes in the sharded cluster instance. Valid values: 2 to 32.
    Note
    • By default, shard nodes use the three-node replica set architecture. We recommend that you specify two or more shard nodes to ensure a proper configuration of data shards. This way, the storage capacity and computing performance of shard nodes can be fully utilized. For more information, see Configure sharding to maximize the performance of shards.
    • By default, a sharded cluster instance supports a maximum of 32 shard nodes. If your business requires more than 32 shard nodes, submit a ticket.
    ConfigServer Specification The specifications of each Configserver node in the sharded cluster instance. This value can be set only to 1 Core, 2 GB (General).
    ConfigServer Storage The storage capacity of each Configserver node in the sharded cluster instance. This value can be set only to 20 GB.
    Set Password The time when you want to set the password of the root account. Valid values:
    • Set Now: You want to immediately set the password of the root account.
    • Set Later: You want to set the password of the root account after the sharded cluster instance is created. For more information, see (Optional) Reset a password.
    Password The password of the root account. If you set the Set Password parameter to Set Now, you must set the password of the root account when you create the sharded cluster instance. You must set the password in compliance with the following rules:
    • The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and specific special characters.

      These special characters include ! @ # $ % ^ & * ( ) _ + - =

    • The password must be 8 to 32 characters in length.
    Duration The subscription duration of the sharded cluster instance. This parameter is displayed only when you specify to create a subscription instance. A valid monthly subscription duration ranges from one month to nine months. A valid yearly subscription duration ranges from one year to five years.
    Note If you want to enable auto-renewal for the sharded cluster instance, select Auto-renewal and make sure that you have sufficient balance within your account before the system automatically renews the instance.
  6. Complete the payment based on the billing method of the instance.
    Billing method Procedure
    Subscription
    1. Complete the parameter settings and click Buy Now.
    2. On the Confirm Order page, check the parameter settings. Then, read MongoDB Sharded Cluster (Subscription) Agreement of Service and select I have read and agree to MongoDB Sharded Cluster (Subscription) Agreement of Service.
    3. Click Pay. On the Purchase page, complete the payment.
    Note You can also click Add to Cart to pay for orders in the cart in a lump sum. For more information, see Pay for orders in the cart.
    Pay-as-you-go
    1. Complete the parameter settings and click Buy Now.
    2. On the Confirm Order page, check the parameter settings. Then, read MongoDB Sharded Cluster (Pay-as-you-go) Agreement of Service and select I have read and agree to MongoDB Sharded Cluster (Pay-as-you-go) Agreement of Service.
    3. Click Activate Now. The system collects the amount due within the next hour.
  7. Check whether the sharded cluster instance is created.
    1. After you complete the payment, click Console to go to the ApsaraDB for MongoDB console.
    2. In the upper-left corner of the page, select the resource group and region to which the instance belongs.
    3. In the left-side navigation pane, click Sharded Cluster Instances.
    4. In the instance list that appears, check whether the sharded cluster instance that you created is displayed.
      • If the sharded cluster instance is displayed, the instance is created. If the sharded cluster instance is in the Running state, the instance is running as expected.
      • If the sharded cluster instance is not displayed, wait for 10 to 15 minutes. Then, refresh the page. If the sharded cluster instance is still not displayed, check whether the issues that are described in the following table occur. If none of the issues occur, contact Alibaba Cloud technical support.
        The following table describes the possible causes of and solutions to the issues due to which the created sharded cluster instance is not displayed.
        Cause Solution
        The sharded cluster instance does not belong to the region that you select. In the upper-left corner of the ApsaraDB for MongoDB console, select the resource group and region to which the sharded cluster instance belongs.
        The sharded cluster instance does not belong to the instance architecture that you select. In the left-side navigation pane of the ApsaraDB for MongoDB console, click Sharded Cluster Instances.
        The sharded cluster instance is not created due to insufficient resources.

        The system may fail to create the instance due to insufficient resources. In this case, your payment is refunded. Go to the Billing Management console and open the Orders page to check whether you receive refunds.

        After you confirm the refunds, perform one of the following operations:
        • Select a different zone and try again.
        • Submit a ticket. For more information, see New Ticket.

Pay for orders in the cart

If you want to purchase a subscription sharded cluster instance, you can also click Add to Cart to pay for orders in the cart in a lump sum after you complete the parameter settings. You can perform the following steps to pay for orders in the cart:
  1. In the lower-right corner of the page, click the Cart icon.
  2. In the Cart panel, select the orders for which you want to pay and click Proceed to Checkout.
  3. On the Cart page, check whether the orders for which you want to pay are selected.
    Note You can also re-specify the Subscription Cycle and Quantity parameters.
    • If the orders for which you want to pay are selected, click Buy Now.
    • Otherwise, select the orders and click Buy Now.
  4. On the Confirm Order page, read ApsaraDB for MongoDB (Subscription) Service Agreement, select I have read and agreed to the terms, and then click Confirm Purchase.
  5. On the Purchase page, complete the payment.

Related API operations

Operation Description
CreateShardingDBInstance
  • Creates an ApsaraDB for MongoDB sharded cluster instance.
  • Clones an ApsaraDB for MongoDB sharded cluster instance.
DescribeInstanceAutoRenewalAttribute Queries whether auto-renewal is enabled for an ApsaraDB for MongoDB instance.
DescribeDBInstanceAttribute Queries the detailed information of an ApsaraDB for MongoDB instance.

What to do next

After the sharded cluster instance is created, perform the following operations: