Usage Guide

Permissions

See Permissions.

Backup Plans

Automatic backup is implemented through backup plans. A backup plan creates backup tasks on a schedule for a file system.

Create a backup plan

1. Select the backup object

• Backup plan name: Auto-generated. You can modify it.
• Object: Only File system is supported.
• File system name: Select a specific file system (running only). Single selection only.

Backup plan templates

• Template 1:
  • Backup days: Sunday
  • Backup time: 01:00
  • Auto retention: 3 months
• Template 2:
  • Backup days: Monday, Wednesday, Saturday
  • Backup time: 01:00
  • Auto retention: 1 month
• Template 3:
  • Backup days: Monday to Sunday
  • Backup time: 01:00
  • Auto retention: 10 days

If you enter the policy page from a template, the system pre-fills backup strategy and retention based on the template, but you can still modify them.

2. Configure the backup strategy

• Automatic backup: Enabled by default. If you disable it, backup days/time are hidden and the UI shows: "If automatic backup is disabled, a backup task is executed only once when the backup plan is created."
• Backup days: Multi-select. Monday, Tuesday, etc.
• Backup time: Multi-select. Choose whole hours from 00:00 to 23:00. The UI recommends: "Run backups during off-peak hours."

3. Configure retention

• Keep forever
• Keep for a duration: Default 1 year, minimum 1 day. Units: day, week, month, year.

After you click Confirm, a new record is added to the backup plan list.

Notes on backup plans

1. Example: For file system fs1, if backup days are Saturday and Sunday and backup times are 01:00 and 02:00, then a backup task runs at 01:00 and 02:00 on Saturday and at 01:00 and 02:00 on Sunday.
2. If data volume is large and one backup takes longer than the interval between two scheduled time points, the next time point is skipped automatically.
   • Example: backup times are 01:00, 02:00, 03:00. If the 01:00 backup takes 70 minutes and finishes at 02:10, then the 02:00 backup is skipped and the next backup time point is 03:00.
3. Backup schedule times are interpreted in UTC+8.

Backup plan list

Fields:

• Backup plan name: Name configured when creating the plan.
• Status: Enabled/Disabled. Enabled plans run automatically; disabled plans do not create new backup tasks.
• Object: File system.
• Name: File system name.
• Automatic backup: On/Off.
• Created at: Plan creation time.
• Backup records: Number of backup tasks created by this plan.

Actions:

• Edit: Backup plan name, object, and file system name are not editable; backup strategy and retention can be modified.
  • Note: Editing a backup plan does not affect historical backup tasks. It applies only to newly created backup tasks.
• Enable/Disable: Can be toggled in either direction. Confirmation prompts:
  • Disable: "Disabling does not affect existing backups. The plan will no longer create new backup tasks. Are you sure?"
  • Enable: "After enabling, backups will continue based on the configured schedule. Are you sure?"
• Delete: Available in any status. Confirmation prompt: "Deleting the backup plan will delete all backup data created by this plan, but it does not affect data restored from backup tasks. Are you sure?"
• Manual backup: Available only when enabled. Creates a backup task immediately. Confirmation prompt: "A backup task will be created immediately. Are you sure?"

Bulk actions:

• Bulk delete: Same confirmation as Delete.
• Bulk enable/disable: Same confirmation as Enable/Disable.
• Bulk manual backup: Same confirmation as Manual backup (enabled plans only).

Backup plan details

Click a backup plan name to open its details page.

Basic attributes:

• Backup plan name
• Status (Enabled/Disabled)
• Object (File system)
• File system name
• Created at
• Updated at
• Backup tasks (count)
• Retention (current setting)
• Automatic backup (if disabled, backup days/time are not shown)

Backup Tasks

Backup tasks generated by the plan are shown under the plan details.

Manual backup

Click Manual backup to create a backup task immediately (with a confirmation prompt). After confirmation, the backup task runs immediately.

Backup task list

Fields:

• Backup job ID: Auto-generated unique ID.
• Status: Completed / In progress / Failed / Skipped / Queued.
  • In progress: Task is running.
  • Completed: Task finished successfully; you can create a restore job from it.
  • Failed: Task creation or execution failed.
  • Skipped: A scheduled time point is skipped because a previous backup is still running (see the example in backup plan notes).
  • Queued: If a restore job for the file system is running, the backup task waits until the restore completes.
• Backup type: Manual or Automatic.
• Start time: Task creation time.
• End time: Task completion time (may be empty if not finished).
• Retention: Retention setting at the time the task was created. The backup data will be cleaned up automatically after it expires.

Actions:

• Delete: Available in any status. Confirmation prompt: "Deleting the backup task will also delete the backup data associated with it. Are you sure?"
• Restore: Available only when status is Completed. You can restore to a new file system.

Bulk actions:

• Bulk delete: Same confirmation as Delete.

Restore Jobs

You can restore backup data from a point in time to a new file system.

Restore from a backup

When you choose Restore to a new file system, provide:

• File system name
• File system edition
• File system capacity: equals the capacity at the time the backup was created (TiB). After restore completes, you can expand the file system manually if needed.
• File system protocol
• Subnet

After you submit:

• A restore record is created in the restore job list to show progress and status.
• A new file system is created and the backup is restored into it.

Restore job list

Fields:

• Restore job ID: Auto-generated global unique ID.
• Backup task ID: The backup task the restore job is created from.
• Status: Completed / In progress / Failed.
• Restore to: The new file system.
• File system name: Click to open the file system details page.
• Start time
• End time: May be empty if not finished.

Actions:

• Delete: Not available while In progress. Available when Failed or Completed. Confirmation prompt: "Deleting the restore record does not affect the restored file system. Are you sure?"

Bulk actions:

• Bulk delete: Available only for deletable restore records.