If you need to back up a large amount of data from an Object Storage Service (OSS) bucket, you can use the OSS inventory feature of Hybrid Backup Recovery (HBR) to accelerate incremental backups. This topic describes how to create and run an OSS backup plan by using the OSS inventory feature.

Prerequisites

  • An OSS bucket whose storage class is Standard or Infrequent Access (IA) is created. For more information, see Create buckets.
  • If you want to use an existing OSS inventory list to create an OSS backup plan, the OSS inventory list must meet the following requirements:
    • The inventory list of the latest version is enabled. The bucket prefix that is used in the inventory list is the same as the value of the Source Path parameter that is specified in the Create Backup Plan panel.
    • The inventory list includes the Object Size, Storage Class, Last Modified Date, and ETag fields.
    oss list

    For more information, see Configure bucket inventory.

Background information

You can use the inventory feature to export information about an object in a bucket, such as the number, size, storage class, and encryption status of the object. If you need to back up a large amount of data from an OSS bucket, you can use the OSS inventory feature of HBR to accelerate incremental backups. If you need to back up more than 100 million objects, we recommend that you use the OSS inventory feature. OSS determines the time at which OSS inventory lists are generated. If you perform a backup before an inventory list is generated, the backup fails.

Usage notes

When you use the OSS inventory feature of HBR to back up OSS data, take note of the following points:
  • HBR cannot back up or restore symbolic links, object access control lists (ACLs), or objects in Archive buckets.
  • You are charged higher fees for access to objects in IA buckets than for access to objects in Standard buckets.
  • You are charged for OSS API operations that are called by HBR during the backup of OSS objects. The charges are included in your OSS bills. For more information, see Overview.
  • If you delete an existing backup, the data integrity of subsequent backups is not affected.
  • You can manage OSS inventory lists in the OSS console. For information about how to create an OSS inventory list, see Configure bucket inventory.
  • To accelerate incremental backups, HBR uses the most recent inventory list that is generated within the previous seven days.
    An OSS inventory list may be generated at a low speed. If you use the OSS inventory list, take note of the following limits:
    • If no inventory list exists when a backup job is performed, the backup job fails.
    • When a backup job is triggered and the inventory list is the same as the inventory list of the previous backup, the backup job fails.
    • When a backup job is triggered, HBR uses the most recent inventory list. After the backup is completed, the objects that you add to the OSS inventory list are backed up in the next backup cycle.
    • The interval at which backups are performed must be greater than or equal to the interval at which OSS inventory lists are generated. This way, you can use an OSS inventory list each time you perform a backup.
    We recommend that you set the time to start the first backup to a point after an OSS inventory list is generated and then click Run Now to perform a manual backup after an OSS inventory list is generated. This way, you can enable the inventory list feature in time to accelerate your backup jobs.

Procedure

To create a backup plan for an OSS bucket, perform the following steps:

  1. Log on to the HBR console.
  2. In the left-side navigation pane, choose Backup > OSS Backup.
  3. In the top navigation bar, select the region where the OSS bucket resides.
  4. On the Backup Plans tab, click Source Bucket.
  5. In the Create Backup Plan panel, set the parameters and click OK.
    Note You can use each backup plan free of charge for one month, starting from the day when the backup plan is created. For example, if you create a backup plan on February 14, 2020, you can use the backup plan for free until March 14, 2020. You are charged for the OSS API operations that are called by HBR during the backup of OSS objects. You are also charged for the storage of OSS inventory lists. The charges are included in your OSS bills. For more information, see OSS billable items and billing methods.
    1. The following table describes the parameters in the basic settings of the backup plan.
      Parameter Description
      Source OSS Bucket The name of the OSS bucket that you want to back up. Select an OSS bucket from the drop-down list.
      Plan Name The name of the backup plan. By default, a random name is used.
      Start Time The time at which the backup plan starts. The time is accurate to seconds.
      Pay After Trial Ends Specifies whether to pay for the backup plan after the free trial period. Valid values:
      • No (default value): The backup plan is not renewed after the free trial for the backup plan ends. If you select this option, the backup plan is deleted after the free trial period.
      • Yes: The backup plan is automatically renewed after the free trial period.
    2. To specify the advanced settings, click Show Advanced Settings, click Switch to Paid Plan to enable the advanced settings, and then set the parameters. The following table describes the parameters.
      Parameter Description
      Source Path The prefix in the names of the objects that you want to back up from the OSS bucket. By default, no prefix is specified and all objects in the root directory of the OSS bucket are backed up.
      Backup Interval The interval at which incremental backup is performed. By default, the backup interval is one day. Unit: minutes, hours, days, or weeks.
      Retention Policy The retention policy of the backup data. Valid values:
      • Limited (default value): Backup data is retained for a specified period of time. If you select Limited, you must set the Retention Period parameter.
      • Permanent: The backup data is permanently retained.
      Retention Period This parameter is required only if the Retention Policy parameter is set to Limited. This parameter specifies the period of time for which the backup data is retained. Default value: 2 (years). Unit: days, weeks, months, or years.
      Backup Vault The backup vault to which you want to store the backup data. Valid values:
      • Create Vault (default value): If you select this option, specify a name for the vault in the Vault Name field. By default, a random name is used.
      • Select Vault: If you select this option, select a backup vault from the Vault Name drop-down list.
      Vault Name The name of the backup vault.
      Vault Resource Group This parameter is required only if the Backup Vault parameter is set to Create Vault. This parameter specifies the resource group to which the backup vault belongs.

      Resource groups allow you to sort the resources of your Alibaba Cloud account for easier resource and permission management. For more information, see Create a resource group.

      Source Encryption Type This parameter is required only if the Backup Vault parameter is set to Create Vault. This parameter specifies the method that is used to encrypt the data in the backup vault.
      • HBR-managed (default value): You can use the default encryption method of HBR.
      • KMS: You can use Key Management Service (KMS) to encrypt data that is stored in the backup vault.
      Notice If you select KMS, you cannot delete or disable the KMS key.
      KMS KeyId This parameter is required only if the Source Encryption Type parameter is set to KMS. This parameter specifies the ID of the KMS key that you can use to encrypt the data in the backup vault.
      Note Before you can use the KMS key to encrypt the data in the backup vault, you must create the key ID in the KMS console. For more information, see Create a CMK.
    3. Configure the OSS inventory feature.
      Parameter Description
      Use OSS Inventory Specifies whether to back up OSS buckets by using the OSS inventory feature. In this example, the parameter is set to Select Inventory.
      • No: disables the OSS inventory feature. You must back up objects in traversal mode.
      • Select Inventory: You can use an existing OSS inventory list to accelerate the incremental backups of OSS objects.
      OSS Inventory Name This parameter is required only if the Use OSS Inventory parameter is set to Select Inventory. You can select an OSS inventory list from the OSS Inventory Name drop-down list. For information about how to create an OSS inventory list, see Configure bucket inventory.
      The OSS inventory list that you create must meet the following requirements:
      • The inventory list of the latest version is enabled. The bucket prefix that is used in the inventory list is the same as the value of the Source Path parameter that is specified in the Create Backup Plan panel.
      • The inventory list includes the Object Size, Storage Class, Last Modified Date, and ETag fields.
      • The interval at which the OSS inventory list is generated must be shorter than the interval at which backups are performed. This way, you can use an OSS inventory list each time you perform a backup.
      Delete inventory file after backup Specifies whether to delete the inventory list after a backup plan is completed. If you set this parameter, you can delete the inventory lists of the bucket. We recommend that you store inventory lists in a dedicated bucket or set the parameter to Do Not Delete to manually manage the lists.
      • Do Not Delete: retains the inventory lists. If subsequent applications access the OSS inventory list, we recommend that you set the parameter to this value.
      • Delete Current: deletes the inventory list that is used in the backup job.
      • Delete All: deletes all the inventory lists that are generated after the backup is completed. If no subsequent applications access the OSS inventory lists, we recommend that you set the parameter to this value.
    After the backup plan is created, HBR runs backup jobs based on the backup plan.

What to do next

On the Backup Plans tab, you can perform the following operations in the Actions column.
Operation Description
Run Now Immediately runs a backup job.
Modify Modifies the parameters of an OSS backup job if the backup job does not meet your business requirements.
Backups You can view all the backup record of the file system or its backup history in the recent three months.
Suspend Plan Suspends a backup job that is running.
Resume Plan Resumes a backup job that is suspended.
Delete Plan Deletes a backup job that is running. After you delete a backup plan, HBR no longer runs the plan. The data that is backed up is retained.
Alert Settings If the backup job fails or the client is disconnected from the server, HBR sends an alert notification by default. For more information, see Configure alert notifications.

What to do next

Create an OSS restore job