ApsaraDB for MongoDB:Download backup files

Prerequisites

Your ApsaraDB for MongoDB instance must meet the following requirements:

• Architecture: replica set (excluding single-node instances) or sharded cluster.

• Storage type: ESSD cloud disk.

• Status: Running.

• Region: The instance is in one of the supported public cloud regions: China (Chengdu), China (Guangzhou), China (Qingdao), China (Beijing), China (Shanghai), China (Zhangjiakou), China (Hangzhou), China (Shenzhen), China (Hong Kong), Malaysia (Kuala Lumpur), Indonesia (Jakarta), Japan (Tokyo), Singapore, Germany (Frankfurt), US (Silicon Valley), or US (Virginia).

• Backup data is not encrypted.

• If you use a RAM user, ensure the user has the required permissions to download backup files.

  How to grant permissions to a RAM user

  1. Log on to the RAM console by using your Alibaba Cloud account.

  2. In the left-side navigation pane, choose Permissions > Policies.

  3. Click Create Policy. On the JSON Editor tab, enter the following policy, and then click Confirm.

     {
       "Statement": [
         {
           "Effect": "Allow",
           "Action": "dds:Describe*",
           "Resource": "*"
         },
         {
           "Effect": "Allow",
           "Action": [
             "dbs:CreateDownload",
             "dbs:DescribeDBInstanceDownloadSize",
             "dbs:DescribeDownloadSupport"
           ],
           "Resource": "*"
         }
       ],
       "Version": "1"
     }

  4. In the Create Policy dialog box, enter a Name and Remarks for the policy. Confirm the policy content and click Confirm again.

  5. In the left-side navigation pane, choose Permissions > Authorize.

  6. Click Grant Permission and attach the policy that you created to the RAM user. For more information, see Grant permissions to a RAM user on the Authorization page.

  7. Click OK.

Supported and unsupported data

• Unsupported:

  • The system databases admin, local, and config.

  • System collections whose names start with system..

  • Views and functions.

  • Time-series collections.

  • The download task fails if database or collection names contain forward slashes (/).

• Supported: Non-time-series collections and index information.

Procedure

1. Go to the backup list

   1. Go to the ApsaraDB for MongoDB Replica Set Instances page or the ApsaraDB for MongoDB Sharded Cluster Instances page. Select the resource group and region, and then click the ID of the target instance.

   2. In the left-side navigation pane of the target instance page, click Backup and Restoration.

   3. On the Backup Download List tab, click Download Instance Backup File.

2. Start a download task: On the Backup Download tab, click Download Instance Backup File.

3. Configure parameters for instance backup download

   1. In the Point in Time and Backup Set step, select a Backup Set to download, and then click Next.

   2. In the Instance, Database, and Table step, retain the default settings to download the instance backup, and then click Next.

   3. In the Destination and Format step, configure the download destination and format.

      Destination	Configuration
      OSS (Recommended)	Select Write data to your OSS. Enter the bucket name and directory prefix of the destination OSS bucket. Only the Standard storage class is supported for OSS. To change the storage class, see Convert storage classes. Select a Download Format. The default format is BSON. If this is the first time you use this feature, click Go to Authorize > Agree to Authorization as prompted to grant ApsaraDB for MongoDB the permissions to access OSS.
      URL	Select URL. Select a download format. After the task succeeds, you must manually generate a download link. The link is valid for a limited period.

4. Confirm and run the task: Read and agree to the terms, and then click Complete. You are redirected to the Backup Download List tab, where you can monitor the task status.

5. Obtain the backup file

   • OSS method: Wait until the task status changes to Successful. The file is automatically stored in the specified OSS bucket and directory.

   • URL method: After the task status changes to Successful, click Generate Link in the Destination column within the 3-day validity period. Set a link validity period (from 5 minutes to 1 day; default is 2 hours) to get the download URL. When the task and link expire, the temporary data is automatically deleted and you must start a new download task.

   Important

   Download tasks may fail due to temporary resource allocation failures during data conversion or unsupported data formats. If a task fails, retry it or contact the Data Disaster Recovery technical support team.

6. Use a command-line tool to download the file

   After obtaining the URL:

   • We recommend that you use a command-line tool, such as wget or curl, to download the file. For more information, see Appendix 1: Download commands in this topic.

   • For small files, you can copy the internet URL to the address bar of a browser to download the file.

Prerequisites

1. You can download backup files only for local disk instances that run MongoDB 4.2 or earlier.

2. Only Physical Backup and Logical Backup files can be downloaded. Snapshot Backup backups cannot be downloaded. To download backup files from other instances, see What do I do if my instance does not support backup file downloads?.

Procedure

1. Go to the backup list

   1. Go to the ApsaraDB for MongoDB Replica Set Instances page or the ApsaraDB for MongoDB Sharded Cluster Instances page. Select the resource group and region, and then click the ID of the target instance.

   2. In the left-side navigation pane of the target instance page, click Backup and Restoration.

2. Start a download task

   1. On the Full Backup tab, find the backup file that you want to download and click Download in the Actions column.

   2. In the Download Backup dialog box, Copy and take note of the Public Connection String or Private Connection String as needed.

   3. Click Confirm.

3. Use a command-line tool to download the file

   After obtaining the URL:

   • We recommend that you use a command-line tool, such as wget or curl, to download the file. For more information, see Appendix 1: Download commands in this topic.

   • For small files, you can copy the internet URL to the address bar of a browser to download the file.

Download on Windows or macOS

Paste the download URL into your browser's address bar and press Enter to download the backup file.

Download on Linux

wget -c '<Download URL of the backup file>' -O <Custom filename><Suffix>

wget -c 'http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/custins5475****/hins1907****_data_20210906103710_qp.xb?Expires=......' -O backupfile._qp.xb