Document Center
ApsaraDB for MongoDB
Release Notes
Product Notification
Notice on changing the monitoring data collection interval to 60 seconds as November 19, 2020
Notice: ApsaraDB for MongoDB has phased MongoDB 3.2 out and released MongoDB 4.2 since February 4
Product Introduction
What is ApsaraDB for MongoDB?
System architecture
Architecture of ApsaraDB for MongoDB
Architecture of standalone instances
Architecture of replica set instances
Architecture of sharded cluster instances
Features
Comparison between ApsaraDB for MongoDB and user-created databases
Scenarios
Instance types
MongoDB versions and storage engines
Glossary
Instance categories
Purchase Guide
Billing items and pricing
Configuration change fees
Quick Start
Usage notes
ApsaraDB for MongoDB console
ApsaraDB for MongoDB console (Standalone Instances)
ApsaraDB for MongoDB console (Replica set instance)
ApsaraDB for MongoDB console (Sharde cluster instance)
Get started
Create an instance
Create a standalone instance
Create a replica set instance
Create a sharded cluster instance
Reset the password
Configure a whitelist for an ApsaraDB for MongoDB instance
Apply for a public endpoint for an ApsaraDB for MongoDB instance
Connect to an instance
Connect to a standalone ApsaraDB for MongoDB instance through DMS
Connect to a replica set ApsaraDB for MongoDB instance through DMS
Connect to a sharded cluster ApsaraDB for MongoDB instance through DMS
Connect to a standalone ApsaraDB for MongoDB instance by using the mongo shell
Connect to a replica set instance by using the mongo shell
Connect to a sharded cluster instance by using the mongo shell
Connection sample code for MongoDB drivers
Migrate data
Migrate user-created standalone MongoDB databases to Alibaba Cloud by using DTS
Migrate the replica set of a user-created MongoDB database to ApsaraDB for MongoDB by using DTS
Migrate a user-created sharded MongoDB database to ApsaraDB for MongoDB by using DTS
Migrate user-created databases to Alibaba Cloud by using tools provided by MongoDB
Migrate user-created MongoDB databases to Alibaba Cloud by using the built-in commands of MongoDB
Migrate a user-created MongoDB database to ApsaraDB for MongoDB by using tools provided by MongoDB
User Guide
Preface
Quick start
Logon and logoff
Billing management
Change the billing method of an ApsaraDB for MongoDB instance from pay-as-you-go to subscription
Enable and disable auto-renewal for an ApsaraDB for MongoDB subscription instance
Manually renew an ApsaraDB for MongoDB subscription instance
Instance connection
Connect to an ApsaraDB for MongoDB instance
Connect to an ApsaraDB for MongoDB instance over the internal network across zones
How to connect an ECS instance to an ApsaraDB for MongoDB instance when they are in different regions
How to connect an ECS instance to an ApsaraDB for MongoDB instance when their network types are different
How to connect an ECS instance to an ApsaraDB for MongoDB instance when they do not belong to the same Alibaba Cloud account
Connect a local client to an ApsaraDB for MongoDB instance over the Internet
Connect a local client to an ApsaraDB for MongoDB instance through an SSL VPN tunnel
Manage MongoDB databases though DMS
Account management
Reset the password for an ApsaraDB for MongoDB instance
Manage user permissions on MongoDB databases
Instance management
Changing Instance Configuration
Change the configuration of a sharded cluster instance
Configuration change overview
Change the number of nodes for a replica set instance
Change the configuration of a standalone or replica set instance
Upgrading Database Version
Upgrade the minor version of an ApsaraDB for MongoDB instance
Upgrade MongoDB versions
Specify a maintenance period
View zones of nodes
Migrate an ApsaraDB for MongoDB instance across zones in the same region
Switch node roles
Export the list of instances
Release an ApsaraDB for MongoDB instance
Restart an ApsaraDB for MongoDB instance
Tag management
Create a tag
Bind existing tags
Filter instances by tag
Unbind or delete a tag
Network connection management
Connection String of a Shard or Configserver Node
Apply for a connection string of a shard or Configserver node
Release the connection string of a shard or Configserver node
Public IP Connection
Apply for a public endpoint for an ApsaraDB for MongoDB instance
Release a public connection string
Enable or disable password-free access for an ApsaraDB for MongoDB instance
Modify a public or internal endpoint of an ApsaraDB for MongoDB instance
Switch the network type of an ApsaraDB for MongoDB instance
Configure a VPC for a new instance
Configure a hybrid access solution to switch the network type of an ApsaraDB for MongoDB instance from Classic Network to VPC
Change the retention period of internal endpoints on the classic network of an ApsaraDB for MongoDB instance
Data security
Configure a whitelist or an ECS security group for an ApsaraDB for MongoDB instance
Configure SSL encryption for an ApsaraDB for MongoDB instance
Configure TDE for an ApsaraDB for MongoDB instance
Use the mongo shell to connect to an ApsaraDB for MongoDB database in SSL encryption mode
SSL connection sample code for MongoDB drivers
Audit logs (new version)
Enable the new audit log feature
Query audit logs
Modify audit settings
Download audit logs
Subscribe to audit log reports
Disable audit logging
Audit logs (previous version)
Configure audit logging for an ApsaraDB for MongoDB instance
Monitoring and alerting
View monitoring information
Set alert rules
Parameter settings
Configure database parameters for an ApsaraDB for MongoDB instance
View the parameter modification history
Primary/Secondary failover
Trigger a primary/secondary failover for a replica set instance
Trigger a primary/secondary failover for a shard of a sharded cluster instance
Log management
Overview
View slow query logs
View error logs
View operation logs
Data migration and synchronization
Overview
Migrate an ECS-hosted user-created MongoDB database that uses the standalone or replica set architecture to ApsaraDB for MongoDB
Migrate the shards of a user-created MongoDB database that hosts on ECS to ApsaraDB for MongoDB
Migrate data between ApsaraDB for MongoDB instances
Migrate data from a replica set MongoDB instance to a sharded cluster instance
Migrate data from a standalone MongoDB instance to a replica set or sharded cluster instance
Migrate the data of an ApsaraDB for MongoDB instance across regions
Migrate data between ApsaraDB for MongoDB instances created by different Alibaba Cloud accounts
Migrate data from a third-party cloud service provider to Alibaba Cloud
Migrate data from Amazon DynamoDB to ApsaraDB for MongoDB by using mongoimport
Migrate data from MongoDB Atlas to ApsaraDB for MongoDB by using mongodump and mongorestore
Migrate data from a MongoDB Atlas database to Alibaba Cloud
Migrate an Amazon DynamoDB database to ApsaraDB for MongoDB by using NimoShake
Use NimoFullCheck to check data consistency after migration
Data synchronization
Use MongoShake to implement delayed synchronization among ApsaraDB for MongoDB instances
Use MongoShake to implement one-way synchronization between ApsaraDB for MongoDB replica set instances
Data backup
Configure automatic backup for an ApsaraDB for MongoDB instance
Manually back up an ApsaraDB for MongoDB instance
Data recovery
Restoration solution overview
Restore data to a new ApsaraDB for MongoDB instance
Create an instance from a backup
Restore data to a new ApsaraDB for MongoDB instance by point in time
Restore data to the current ApsaraDB for MongoDB instance
Restore data of an ApsaraDB for MongoDB instance to user-created MongoDB databases by using logical backup
Recover physical backup data in a user-created MongoDB instance
Download the physical backup data of a replica set instance
Restore data of an ApsaraDB for MongoDB instance to user-created MongoDB databases by using physical backup
CloudDBA
Real-time performance
Instance sessions
Slow query logs
Capacity analysis
Zone-disaster restoration solution
Create a multi-zone replica set instance
Create a multi-zone sharded cluster instance
Performance White Paper
Overview
Test environment
Test tool
Test procedure
Test results
Security White Paper
Overview
Access control
Data backup
Version maintenance
Network isolation
Service authorization
Best Practices
Performance
Configure sharding to maximize the performance of shards
Troubleshoot the high CPU usage of ApsaraDB for MongoDB
Defragment a disk to improve disk usage
Connect to a replica set instance and implement read /write splitting and high availability
Import and export MongoDB data through Data Integration
Best practices for data security of ApsaraDB for MongoDB
Set common alert rules for ApsaraDB for MongoDB
Migrate Azure Cosmos DB's API for MongoDB to ApsaraDB for MongoDB
Manage the ApsaraDB for MongoDB balancer
Redirect read requests to data images while data is being updated
Use a connection string URI to connect to a sharded cluster instance
Use MongoDB to store logs
MongoDB sharding
How a replica set in MongoDB works
API Reference
Common parameters
Request structure
Request signatures
How to use RAM authorization
Use RAM for MongoDB Resource Authorization
MongoDB resource types that can be authorized in RAM
Operations that can be authorized in RAM
Authorization rules of API
List of API operations by function
Lifecycle management
CreateDBInstance
ModifyDBInstanceSpec
DeleteDBInstance
CreateShardingDBInstance
CreateNode
DeleteNode
ModifyNodeSpec
DescribeInstanceAutoRenewalAttribute
Region management
MigrateAvailableZone
DescribeRegions
MigrateToOtherZone
Resource Management
DescribeAvailableResource
EvaluateResource
Connection Management
ModifyDBInstanceNetworkType
ModifyInstanceVpcAuthMode
ReleasePublicNetworkAddress
AllocatePublicNetworkAddress
DescribeShardingNetworkAddress
ReleaseNodePrivateNetworkAddress
ModifyDBInstanceConnectionString
AllocateNodePrivateNetworkAddress
Querying Instance Information
DescribeReplicaSetRole
DescribeKernelReleaseNotes
DescribeAvailableEngineVersion
DescribeDBInstances
DescribeDBInstanceAttribute
DescribeRoleZoneInfo
DescribeActiveOperationTaskCount
DescribeActiveOperationTaskType
DescribeDedicatedClusterInstanceList
Instance management
RestartDBInstance
ModifyDBInstanceMaintainTime
ModifyDBInstanceDescription
SwitchDBInstanceHA
UpgradeDBInstanceEngineVersion
DestroyInstance
UpgradeDBInstanceKernelVersion
ModifyDBInstanceNetExpireTime
Tag management
TagResources
ListTagResources
DescribeTags
UntagResources
Account management
ResetAccountPassword
DescribeAccounts
ModifyAccountDescription
IP Whitelist and Security Groups
DescribeSecurityIps
ModifySecurityIps
DescribeSecurityGroupConfiguration
ModifySecurityGroupConfiguration
Encription Keys
ModifyDBInstanceTDE
DescribeDBInstanceTDEInfo
CheckCloudResourceAuthorized
DescribeDBInstanceEncryptionKey
DescribeUserEncryptionKeyList
SSL encryption
DescribeDBInstanceSSL
ModifyDBInstanceSSL
Audit Logs
DescribeAuditRecords
DescribeAuditFiles
DescribeAuditPolicy
ModifyAuditLogFilter
DescribeAuditLogFilter
ModifyAuditPolicy
Log management
DescribeSlowLogRecords
DescribeErrorLogRecords
DescribeRunningLogRecords
DescribeMongoDBLogConfig
Performance monitoring management
DescribeDBInstancePerformance
ModifyDBInstanceMonitor
DescribeDBInstanceMonitor
Parameter management
DescribeParameterModificationHistory
DescribeParameterTemplates
ModifyParameters
DescribeParameters
Index recommendations
CreateRecommendationTask
DescribeAvailableTimeRange
Backup and recovery
DescribeBackupPolicy
ModifyBackupPolicy
CreateBackup
DescribeBackups
RestoreDBInstance
DescribeBackupDBs
CheckRecoveryCondition
Renewal management
DescribePrice
RenewDBInstance
DescribeRenewalPrice
TransformToPrePaid
ModifyInstanceAutoRenewalAttribute
Appendix
Error codes
Instance specifications
Instance states
Performance metrics
Valid values of the InstanceStatus parameter for DescribeDedicatedClusterInstanceList
SDK Reference
Download SDKs
Java SDK
Product Usage
Hot issues
Product features
Database connections
Performance and storage space
Account and permission management
errors and exception handling
General Reference
Guidelines for the use of documentation
Alibaba Cloud documentation
Instructions for open source documentation
Open-Source Documentation Code of Conduct
Editing Open-Source Documentation
Alibaba Cloud console
Regions and zones
Service limits
Create an AccessKey pair
ICP Filing
Glossary
All Products
Search
Document Center
ApsaraDB for MongoDB
Product Usage
Hot issues
This Product
This Product
All Products
ApsaraDB for MongoDB
The system prompts "Timeout while receiving message" when logging on to apsaradb for MongoDB through the Mongo Shell from a Linux instance
How to query and limit the number of connections to an apsaradb for MongoDB instance
How can I troubleshoot the problem of high load on an apsaradb for MongoDB instance?
Write failures caused by disk space exhaustion in MongoDB
Why does ApsaraDB for MongoDB trigger primary/standby switchovers?
How do I understand the names and sources of an IP address whitelist for ApsaraDB for MongoDB?
Why am I unable to find the ApsaraDB for MongoDB instance that I created?
How to troubleshoot database connection failures after the number of connections reaches the upper limit
Free Trial
Free Trial