All Products
Search
Document Center

Cloud Backup:Register an on-premises MySQL database

Last Updated:Dec 31, 2025

Before using Cloud Backup to back up a MySQL database on an on-premises server, you must register the database instance in the Cloud Backup console.

Prerequisites

  • The preparations are complete. For more information, see Preparations.

  • An Express Connect circuit or a VPN gateway connects the on-premises network to an Alibaba Cloud VPC. Additionally, the on-premises network's CIDR block must not overlap with the 100.64.0.0/10 address range, which is reserved for internal communication by the Cloud Backup service.

Procedure

  1. Log on to the Cloud Backup console.

  2. In the left navigation pane, select Backup > Database Backup. Select a region and then click MySQL. On the Local Database Instance tab, click Register Database Instance.

    image

  3. In the Add Client pane, follow the instructions in the wizard to install the client.

    1. Download and decompress the backup client for Linux.

      Copy the download link provided in the console. On your on-premises server, use a command-line tool like wget to download the backup client.

      wget https://a-hbr-resource-shanghai.oss-cn-shanghai.aliyuncs.com/unibackup/hbr-uni-install-linux.tar.gz

      Run the tar command to decompress the backup client.

      tar -zxvf hbr-uni-install-linux.tar.gz
    2. On your on-premises server, navigate to the directory where you extracted the client files. Copy the activation command from the Cloud Backup console and run it.

      The following sample command is from the Cloud Backup console.

      sudo ./client init local-uni --uniUserInfoToken "eyJ1cmwiOiJodHRwczovL2EtaGJyLXJlc291cmNlLWhhbmd6aG91Lm9zcy1jbi1oYW5nemhvdS1pbnRlcm5hbC5hbGl5dW5jcy5jb20vY2xpZW50L2luc3RhbGwvZGJhY2t1cF9hZ2VudC9saW51eDY0LzguMC4yOTI5Mi0xLjAyODU3NzYuZGJnLyIsImhvc3QiOiIxMDAuMTAzLjguMTE2IiwicG9ydCI6NjAzMDUsIm15c3FsQWdlbnQiOiJZZXMiLCJtc3NxbEFnZW50IjoiTm8iLCJvcmFjbGVBZ2VudCI6Ik5vIiwidmVyc2lvbiI6IjguMC4yOTI5Mi0xLjAyODU3NzYuZGJnIiwiYWNjZXNzS2V5IjoiMzI1OGE3NDJmNzU4ZmFjNmVhMGRhMjEwZDRiZjA5NjAiLCJ1c2VTc2wiOiJZZXMiLCJhZ2VudCI6Im15c3FsIiwidXNlclRva2VuIjoiMDVUR0IwNUUiLCJyZWdpb25JZCI6ImNuLWhhbmd6aG91Iiwic291cmNlVHlwZSI6Ik1ZU1FMIn0="

    After the client is activated, the instance is registered with Cloud Backup. The client status will be updated in the console. On the Local Database Instance tab, view the installation status of the client on each node and upgrade the client as needed.

  4. Grant permissions and reactivate the instance.

    1. Return to the console. In the Actions column of the target database instance, choose More > Reactivate.

    2. In the Activate Instance dialog box, enter the required information and click OK.

      Parameter

      Description

      Database Account

      The username of the database instance.

      The minimum permission set of the user is RELOAD, LOCK TABLES, REPLICATION, and PROCESS. For more information, see Before you begin.

      Password

      The user password.

More operations

How can I delete a registered database instance?

  1. Log on to the on-premises server and run the appropriate command to uninstall the backup client.

    • CentOS

      sudo rpm --erase "dbackup3-agent-mysql"
      sudo rpm --erase "dbackup3-agent"
      sudo rpm --erase "dbackup3-common"
    • Ubuntu

      sudo dpkg -r "dbackup3-agent-mysql" "dbackup3-agent" "dbackup3-common"
  2. On the Local Database Instance tab, find the target instance. In the Actions column, choose More > Unregister Instance.

  3. In the dialog box, click OK.

Next step

Back up a MySQL database