Help Center> Document Database Service> User Guide> Data Backups> Configuring the Cross-Region Backup Policy
Updated on 2023-12-13 GMT+08:00

Configuring the Cross-Region Backup Policy

DDS can store backup files in the destination region or OBS, so you can use the backup files in the destination region to restore data to a new DDS instance.

After the cross-region backup policy is enabled, the system automatically stores the backup files created for the instance to the destination region you specified. You can manage cross-region backup files on the Backups page.

Before You Start

  • To apply for the permission to set cross-region backup policies, contact customer service.
  • Before enabling the cross-region backup policy, ensure that the automated backup policy has been enabled. Otherwise, the cross-region backup cannot take effect. For details, see Enabling or Modifying an Automated Backup Policy.

Precautions

Cross-region backup is only supported in the regions listed in the following table.

Table 1 Supported regions

Source Region

Destination Region

CN North-Beijing4

CN East-Shanghai1 and CN South-Guangzhou

CN East-Shanghai1

CN North-Beijing4 and CN South-Guangzhou

Enabling or Modifying a Cross-Region Backup Policy

  1. Log in to the management console.
  2. Click in the upper left corner and select a region and a project.
  3. Click in the upper left corner of the page and choose Databases > Document Database Service.
  4. On the Instances page, click the target instance.
  5. In the navigation pane on the left, choose Backups & Restorations.
  6. On the Backups & Restorations page, click Set Cross-Region Backup Policy.

    Figure 1 Set Cross-Region Backup Policy
    Table 2 Parameter description

    Parameter

    Description

    Cross-Region Full Backup

    Click to back up the automated full backup file of the instance to a remote location.

    Cross-Region Incremental Backup

    Click to back up the incremental backup file of the instance to a remote location.

    NOTE:
    • Only replica set instances support cross-region incremental backup.
    • If cross-region full backup is not enabled, cross-region incremental backup cannot be enabled.
    • After cross-region incremental backup is enabled, you can restore an instance to a specified time point only after the next automated full backup replication is complete. The specified time point must be later than the time when the automated full backup is complete.

    Region

    Select the region for which you back up data based on service requirements.

    Retention Period

    Retention Period refers to the number of days (range: 1 to 1,825) that data is kept. You can increase the retention period to improve data reliability.

  7. Click OK.
  8. On the Cross-Region Backups tab of the Backups page, manage cross-region backup files.

    Figure 2 Cross-region backups
    • To modify the cross-region backup policy, click Set Cross-Region Backup in the Operation column.
    • To view generated cross-region backup files, click View Cross-Region Backup in the Operation column. You can use the cross-region backup files to restore data to a new instance.

Disabling a Cross-Region Backup Policy

  1. Log in to the management console.
  2. Click in the upper left corner and select a region and a project.
  3. Click in the upper left corner of the page and choose Databases > Document Database Service.
  4. On the Instances page, click the target instance.
  5. In the navigation pane on the left, choose Backups & Restorations.
  6. On the Backups & Restorations page, click Set Cross-Region Backup Policy.
  7. In the displayed dialog box, click to disable the cross-region backup policy.

    Figure 3 Disabling a cross-region backup policy

  8. Click OK.

    • If the cross-region backup policy is disabled, the cross-region backup task will be stopped immediately, and all cross-region backup and cross-region incremental backup files will be immediately deleted. Operations related to cross-region backup or incremental backup may fail.
    • After an instance is deleted, all cross-region backups and incremental backups of the instance will be retained. The retention period is determined by the retention period you specified in the cross-region backup policy.