This topic describes how to manage sharded cluster instances in the ApsaraDB for MongoDB console. The ApsaraDB for MongoDB console is a web application that is used to manage ApsaraDB for MongoDB instances. In the ApsaraDB for MongoDB console, you can create ApsaraDB for MongoDB instances and configure IP address whitelists, passwords, and network types for the instances.

Prerequisites

Your Alibaba Cloud account is used to log on to the ApsaraDB for MongoDB console. To create an Alibaba Cloud account, visit the Create Your Alibaba Cloud Account page.

Homepage of the ApsaraDB for MongoDB console

The homepage of the ApsaraDB for MongoDB console is the same for all sharded cluster instances.

Log on to the ApsaraDB for MongoDB console and go to the Sharded Cluster Instances page. The following figure shows an example.

Homepage of the ApsaraDB for MongoDB console

The following table describes the UI elements on the homepage of the ApsaraDB for MongoDB console.

No. UI element Description
Sharded Cluster Instances The Sharded Cluster Instances page displays all sharded cluster instances that are created within your Alibaba Cloud account in a specific region.
Region After you select a region, all sharded cluster instances that belong to the selected region are displayed on the Sharded Cluster Instances page.
Refresh You can click the Refresh button to refresh the Sharded Cluster Instances page.
Create Instance You can click the Create Instance button to create a sharded cluster instance. For more information, see Create a sharded cluster instance.
Instance ID/Name
  • You can click the ID of a sharded cluster instance to open the page that displays the details about the instance.
  • You can click the Edit icon icon in the Instance ID/Name column of a sharded cluster instance to modify the name of the instance. If you do not modify the name, the name is the same as the ID.
Status The Status column displays the statuses of sharded cluster instances. Different instances may be in different states.
Manage You can click the More icon icon in the Actions column of a sharded cluster instance to show more options. These options provide entry points for you to perform various operations on the instance. For example, you can manage, restart, and release the instance.
Export You can click the Export button to export the information about the sharded cluster instances that you select. For more information, see Export the list of instances.

Procedure

  1. Log on to the ApsaraDB for MongoDB console.
  2. In the top navigation bar, select the resource group and region to which the sharded cluster instance belongs.
  3. In the left-side navigation pane, click Sharded Cluster Instances.
  4. Find the sharded cluster instance. In the Actions column, click the More icon icon to show more options. Then, click Manage.
You are directed to the page that displays details about the sharded cluster instance.
Category Name Description References
Top tool bar - The top tool bar provides entry points for you to back up and restart the sharded cluster instance.
Basic Information Basic Information In the Basic Information section, you can view the basic information about the sharded cluster instance. The basic information includes the ID, region, zone, network type, and storage engine of the instance. None
Specification Information In the Specification Information section, you can view the specification information about the sharded cluster instance. The specification information includes the MongoDB version, maintenance window, billing method, creation time, and expiration time of the instance. Specify a maintenance window
Mongos List or Shard List
  • In the Mongos List section, you can find the mongos node that you want to manage, and click the More icon icon in the Actions column to show more options. These options provide entry points for you to log on to the mongos node, restart the mongos node, and change the specifications of the mongos node.
  • In the Shard List section, you can find the shard node that you want to manage, and click the More icon icon in the Actions column to show more options. These options provide entry points for you to log on to the shard node, restart the shard node, perform a failover, and change the specifications of the shard node.
  • When a node is being restarted, the read and write operations on the node may fail. We recommend that you do not perform Create, Retrieve, Update, and Delete (CRUD) operations on the node during a restart.
Backup and Recovery - On the Backup and Recovery page, you can view and download the data backup files that are generated over a time range, restore the data within a specific time range, and create an instance by using the data from a backup file or the data at a specific point in time.
Monitoring Data - On the Monitoring Data page, you can view the metrics of the mongos and shard nodes in the sharded cluster instance over a specific time range. None
Data Security Whitelist Settings On the Whitelist Settings page, you can configure IP address whitelists for the sharded cluster instance. Configure an IP address whitelist for a sharded cluster instance
Audit Logs On the Audit Logs page, you can view the logs about all operations that are performed on the sharded cluster instance. You can use these logs to analyze the performance of the instance. Configure audit logging for an ApsaraDB for MongoDB instance