All Products
Search
Document Center

Cloud Backup:Install a Cloud Backup client for ECS file backup

Last Updated:Feb 18, 2024

Before you can back up files from an Elastic Compute Service (ECS) instance and restore these files, you must install a Cloud Backup client on the ECS instance in the Cloud Backup console.

Background information

You can use the wizard in the Cloud Backup console to install Cloud Backup clients on multiple ECS instances in the same region. You can also use a template to install Cloud Backup clients on a large number of or all of the ECS instances in the same region.

If the version of a Cloud Backup client for ECS file backup is outdated, you can upgrade the client to the latest version. If the activation or upgrade of a Cloud Backup client fails, you must uninstall and reinstall the client. If you no longer need the backup data in a Cloud Backup client, you can delete the client.

Install Cloud Backup clients on multiple ECS instances

To install Cloud Backup clients on multiple ECS instances in the same region, perform the following steps:

  1. Log on to the Cloud Backup console.

  2. In the left-side navigation pane, choose Backup > ECS File Backup.

  3. In the top navigation bar, select the region where the ECS instances reside.

  4. In the upper-right corner of the ECS Instances tab, click Add ECS Instance.

  5. In the Add ECS Instance pane, configure the parameters. The following table describes the parameters.

    Parameter

    Description

    Backup Vault

    The backup vault where you want to store the backup data. A backup vault is a repository that Cloud Backup uses to store backup data. You can use a single vault to store backup data that is received from multiple Cloud Backup clients. Backup vaults reside in different regions. You can select or create a backup vault only in the specified region.

    • If you have created backup vaults, click Select Vault and select a backup vault from the Vault Name drop-down list.

    • If no backup vault is available, click Create Vault and specify a name in the Vault Name field to create a backup vault. The vault name must be 1 to 64 characters in length.

    Use HTTPS

    Specifies whether to use HTTPS to transmit encrypted data that is stored in the backup vault. If you use HTTPS to transmit data, the performance of data transmission is degraded. If you modify the setting of this parameter, the modification takes effect on the next backup or restore job.

    ECS Instances

    In this section, select the ECS instances on which you want to install Cloud Backup clients. To search for ECS instances, perform the following steps: Select Instance ID, Instance Name, VPC ID, or Private IP (VPC) from the drop-down list next to the search box. Enter a partial or entire keyword in the search box.

  6. Click Create. Cloud Backup then installs a client on each selected ECS instance.

Install Cloud Backup clients on a large number of ECS instances

To install Cloud Backup clients on a large number of ECS instances in the same region, perform the following steps:

  1. Log on to the Cloud Backup console.

  2. In the left-side navigation pane, choose Backup > ECS File Backup.

  3. In the top navigation bar, select the region where the ECS instances reside.

  4. In the upper-right corner of the ECS Instances tab, choose Batch Action > Add ECS Instances.

  5. In the Add ECS Instances pane, enter a backup vault name in the Vault Name field. The name must be 1 to 64 characters in length.

  6. Optional. Select Private IP (VPC) to specify the private IP addresses of the ECS instances on which you want to install Cloud Backup clients.

    Note
    • By default, the template lists the ECS instances in the region. On these ECS instances, the Cloud Assistant client is installed but the Cloud Backup client is not installed.

    • If you specify IP addresses of ECS instances, the template lists only the specified ECS instances.

    • Separate multiple IP addresses with commas (,).

  7. Click Download Template.

  8. Open the template, specify the Access Key ID and Access Key Secret fields for ECS instances in the VPC, and save the template. You do not need to specify AccessKey pairs for ECS instances of the VPC type.

    Note
    • If you attempt to install Cloud Backup clients on more than 20 ECS instances by using a template, Cloud Backup automatically creates backup vaults to support the Cloud Backup clients.

    • For more information about how to obtain an AccessKey pair, see View the information about AccessKey pairs of a RAM user.

    • If you do not need to install a Cloud Backup client on an ECS instance, delete the row that corresponds to the ECS instance from the template.

    • We recommend that you do not change the values in the Instance ID, Instance Name, and Network Type columns.

    • To ensure account security, we recommend that you delete the local template after the template is uploaded to Cloud Backup.

  9. Click Upload Template.

    After the template is uploaded, the number of ECS instances of the VPC type is displayed.

Manage a Cloud Backup client

On the ECS Instances tab of the ECS File Backup page, find the ECS instance that hosts the Cloud Backup client. To search for an ECS instance, select Private IP (VPC) from the drop-down list next to the search box, enter the IP address of the ECS instance, and then click the Search icon.

You can view the installation status of the Cloud Backup client. After the Cloud Backup client is installed, you can uninstall, delete, or upgrade the Cloud Backup client.

Operation

Description

Check the installation status of the Cloud Backup client

If the Cloud Backup client is installed, the client status is Activated. If the client status is Failed, a Cloud Backup client fails to be installed. Follow the instructions in the error message to fix the error. After the error is fixed, choose More > Install Client in the Actions column.

Uninstall the Cloud Backup client

Choose More > Uninstall Client in the Actions column.

Delete the Cloud Backup client

To uninstall the Cloud Backup client from the ECS instance and remove the ECS instance, choose More > Remove in the Actions column.

Note

After you delete a Cloud Backup client, the existing backup data is also deleted and running backup and restore jobs fails. Before you delete a Cloud Backup client, make sure that the backup data in the client is no longer required and the client has no running backup or restore jobs.

Upgrade the Cloud Backup client to the latest version

Click Upgrade in the Client Type column.