Back up a tenant now

2025-03-28 08:05:55  Updated

This topic describes how to back up a tenant immediately.

You can back up a tenant immediately by using one of the following methods.

  • Method 1: Log in to the OceanBase Cloud Platform (OCP) console. In the left-side navigation pane, choose Backup & Recovery > Backups . On the Backups page, click Back up Now in the upper-right corner of the page and choose Back Up Tenant from the drop-down list.

  • Method 1: Log in to the OCP console and go to the Overview page of the target tenant. In the left-side navigation pane, click Backup & Recovery . Then, click Back up Now.

Prerequisites

  • To back up a tenant by using Method 1, make sure that you have the following permissions:

    • Resource Permissions : Cluster Maintenance or Tenant Maintenance permission
    • Menu Permissions : Permission on the Backup menu of Backup & Recovery
  • To back up a tenant by using Method 2, make sure that you have the following permissions:

    • Resource Permissions : Cluster Maintenance or Tenant Maintenance permission
    • Menu Permissions : Permission on the Backup & Recovery menu of Tenants
  • Tenant backup is supported only in OceanBase Database V3.2.2-20220304134610 and later.

Procedure

The procedure of Method 1 is described as follows:

  1. Log in to the OCP console.

  2. In the left-side navigation pane, choose Backup & Recovery > Backups . On the Backups page, click Back up Now in the upper-right corner of the page and choose Back Up Tenant from the drop-down list.

  3. Select the object that you want to back up.

    Select the object that you want to back up from the Backup Tenant drop-down list. The system automatically identifies OceanBase Version and Backup Method of the tenant and automatically populates the fields of Storage Configuration .

  4. Specify Storage Configuration .

    • If the tenant that you want to back up has a backup strategy, the fields in the Storage Configuration section are automatically populated.

    • Otherwise, you must manually specify the configuration. You can specify the configuration as prompted or by following the instructions of Step 4 in Create a tenant-level backup strategy.

      Then, click Test .

    Image 47

  5. Select a data backup method.

    For physical backup, select a data backup method. For logical backup, only full backup is supported.

    Notice

    • For physical backup, you must perform a full backup before you can perform an incremental backup. Otherwise, the following error message is returned in the Check if ready to data backup step: "full data backup needed before incremental data backup."
    • If the error message "Cluster compaction needed before full data backup" is returned in the Start cluster compact if necessary step of a full backup, perform a major compaction and click Retry.
  6. Click Back up Now.

Contact Us