You can use Cloud Backup to back up files from your ECS instances and restore them if lost or damaged.
The backup client has been upgraded to ECS File Backup (client V2.0). We recommend using client V2.0 to back up ECS files. For more information, see Comparison between client V1.0 and V2.0 of ECS File Backup.
Prerequisites
You have completed the prerequisites.
Back up files from a single ECS instance
Follow these steps to back up files from a single ECS instance:
Log on to the Cloud Backup console.
In the left-side navigation pane, choose .
On the ECS File Backup page, click the ECS instances tab.
Find the target ECS instance and click Back Up in the Actions column.
On the Create backup plan page, configure the following parameters and click Create.
Parameter
Description
Plan name
Enter a name for the backup plan. This parameter is optional. If you leave it empty, a random name is generated.
Source paths
The rules for backup paths are as follows:
Enter up to eight paths without using wildcards (*).
If you use a wildcard (*), enter only one path. The path can be in a format like
/*/*.Paths must be absolute, such as starting with /, \\, C:\, or D:\.
NoteYou cannot back up from multiple root paths at the same time. For example, you cannot back up from C:\ and D:\ simultaneously.
You cannot use VSS with multiple paths, UNC paths, wildcards, or file exclusions.
You cannot use VSS, wildcards, or file exclusions with UNC paths. Additionally, Windows ACLs are not backed up for UNC paths.
Backup rule
Select Include all files or Exclude specified files.
If you select Exclude specified files, you must enter a list of files to exclude.
NoteThe exclusion rules are as follows:
You can specify up to eight exclusion paths, including paths with wildcards (*).
If a path does not contain a forward slash (/), a wildcard (*) matches multiple levels of directories or filenames. For example, *abc* matches /abc/, /d/eabcd/, and /a/abc. *.txt matches all files with the .txt extension.
If a path contains a forward slash (/), each wildcard (*) matches only a single level of a directory or filename. For example, /a/*/*/share matches /a/b/c/share but does not match /a/d/share.
A path ending with a forward slash (/) matches a folder. For example, *tmp/ matches /a/b/aaatmp/ and /tmp/.
Use a forward slash (/) as the path separator for Linux and a backslash (\) for Windows.
Start time
Select the time when the backup plan starts. The time is accurate to the second.
Backup interval
Select the frequency for incremental backups. You can set the interval in hours, days, or weeks.
NoteThe maximum backup interval is 52 weeks (one year).
Retention period
Select how long to keep the backups. You can set the retention period in days, weeks, months, or years.
Use VSS
This feature is available only for Windows instances.
If the source data changes during backup and you need to ensure data consistency, select Yes.
If you select Yes, you cannot back up files from multiple directories at the same time.
NoteThis feature is not supported if the backup source is on an exFAT-formatted volume.
Throttle bandwidth
Bandwidth throttling limits backup traffic to prevent affecting your regular services.
If you select Yes, select a Throttling period, enter the Max bandwidth that backups can use during that period, and then click Add.
Back up files from multiple ECS instances
To back up files from multiple ECS instances, create the backup plans in a batch.
Log on to the Cloud Backup console.
In the left-side navigation pane, choose .
In the top navigation bar, select the region where the ECS instances are located.
In the upper-right corner, choose .
On the Create backup plans page, click Download template.
Open the downloaded template, fill it out as described in the table, and save the file.
NoteIf you do not want to back up a specific instance, delete the corresponding row from the template.
Parameter
Description
Client ID
The ID of the available backup client. Do not modify this value.
Instance ID
The ID of the ECS instance that is associated with the client. Do not modify this value.
Instance name
The name of the ECS instance that is associated with the client. Do not modify this value.
Source
Enter the path to the files or directories that you want to back up. The path must be an absolute path.
Plan name
Enter a name for the backup plan. This parameter is optional. If you leave it empty, a random name is generated.
Retention (days)
Enter an integer for the retention period.
Unit: Day.
This parameter is optional. By default, backups are retained for 730 days.
Effective time
Enter the start time for the backup plan. Use the
YYYY-MM-DD/HH:MM:SSformat. Example: 2018-12-03/12:00:00.Backup interval
Enter an integer for the incremental backup interval.
Unit: Hour.
This parameter is optional. The default interval is 24 hours.
Use VSS for backup
This feature is available only for Windows instances.
Enable this feature to ensure data consistency when source data changes during a backup.
Enter Y to enable this feature or N to disable it. This parameter is optional. By default, this feature is disabled.
If you use VSS, you cannot back up files from multiple directories at the same time.
Bandwidth throttling
Bandwidth throttling controls the bandwidth used for backups to avoid affecting your regular services.
If you use this feature, enter the maximum bandwidth that backups can use at all times.
Enter an integer. Unit: MB.
This parameter is optional. By default, bandwidth is not throttled.
Click Upload File and upload the completed template.
Click Create.
Browse backup files online
Cloud Backup's online browsing feature lets you quickly view the files in a backup plan.
On the Backup plans and jobs tab, find the backup job and click View in the Actions column.
Click Browse.
On the Browse tab, you can view all files in the source directory. The Browse dialog box opens and displays an orange notification at the top: This page is for browsing only. To restore files, go to the instance list. The file tree on the left shows the backup directory structure. The root node is All Files. You can expand the nodes level by level to view subfolders in the
datadirectory.ImportantThis page is for browsing only. To restore ECS files, see Restore ECS files.
Related operations
On the ECS File Backup page, click the Backup plans and jobs tab. You can perform the following operations:
Actions | Procedure |
View an error report | Find the backup job and check its progress. If some files failed to back up, click View. In the Errors column, click the download icon to download the error report. |
Start a backup | Find the backup job and in the Actions column, choose . |
Cancel a running backup job | Find the running backup job and in the Actions column, choose . |
Suspend a running backup job | Find the running backup job and in the Actions column, choose . |
Resume a suspended backup job | Find the suspended backup job and in the Actions column, choose . |
Modify a backup plan | Find the backup plan and in the Actions column, choose . |
Delete a backup plan | Find the backup plan and in the Actions column, choose . After you delete a backup plan, it no longer runs, but existing backup data is retained. |
FAQ
If a file backup fails, for example, due to an unstable network, you can configure retry parameters:
Log on to the server that you want to back up.
Navigate to the installation directory of the Cloud Backup client.
In a subdirectory of the
clientfolder, create a file namedhbr.config.NoteThe
hbr.configfile must be in the same directory as thehybridebackupandidsexecutable files.Add the following parameters to the
hbr.configfile.Parameter
Description
retry_times
The number of retries for a failed backup. Default value: 3.
retry_interval
The interval between retries. Default value: 100 ms.
skip_error_files
Specifies whether to skip files that cannot be backed up.
false (default): The backup job fails if any file cannot be backed up.
true: The backup job skips any unreadable files and continues.
A sample configuration of the hbr.config file is as follows:
retry_times=3
retry_interval=100
skip_error_files=false