Help Center/ Cloud Service Engine/ User Guide/ ServiceComb Engines/ Managing ServiceComb Engines/ Configuring Backup and Restoration of a ServiceComb Engine
Updated on 2025-08-29 GMT+08:00

Configuring Backup and Restoration of a ServiceComb Engine

CSE provides the backup and restoration functions. You can back up and restore ServiceComb engine data, including microservices, contracts, configurations, and account role.

You can customize backup policies to periodically back up ServiceComb engines or manually back up ServiceComb engines.

Restrictions

  • Each ServiceComb engine supports a maximum of 15 successful backups, including a maximum of 10 manual backups and a maximum of 5 automatic backups.
  • The backup data will be stored for 10 days. Expired backup data will be deleted.
  • The backup data will overwrite the current data of the ServiceComb engine. As a result, the microservice and service instances may be messed, and dynamic configurations may be lost. Exercise caution when performing this operation.
  • If security authentication is enabled, the backup data contains the account information. You are advised to disable security authentication before restoring the backup data. Otherwise, the authentication for accessing the ServiceComb engine may fail after the restoration.

Automatic Backup

  1. Click the target engine.
  2. In the Backup and Restoration area, click Automatic backup settings and set backup parameters.

    Table 1 Automatic backup parameters

    Parameter

    Description

    Automatic Backup

    After automatic backup is disabled, the previously set backup policy will be deleted. In this case, you need to set the backup policy again.

    Backup Interval

    Backup period. Interval at which the system automatically backs up data. You can select one or more days from Monday to Sunday as the backup execution date. The selected dates will trigger automatic backup.

    This parameter takes effect after Automatic Backup is enabled.

    Trigger Time

    Time when a backup task starts. The backup task is triggered at the specified time on all the dates of the backup interval. Only the hour is supported.

    This parameter takes effect after Automatic Backup is enabled.

  3. Click OK.

    Once the backup policy is set, the backup task is triggered within one hour after the preset time.

Manual Backup

  1. Click the engine whose data you want to manually back up.
  2. In the Backup and Restoration area, click Create Manual Backup and set backup parameters.

    Table 2 Manual backup parameters

    Parameter

    Description

    Name

    Enter a backup task name. The name contains 3 to 24 characters, including letters, digits, and hyphens (-), and starts with a letter but cannot end with a hyphen (-). The name cannot be changed once the backup task is created.

    Remarks

    (Optional) Enter a description. The description can contain 0 to 255 characters.

  3. Click OK to execute the backup task immediately. A backup task is generated in the backup task list. If the execution result changes from Processing to Successful, the manual backup is successful.

Restoring Backup Data

The backup data will overwrite the current data of the ServiceComb engine. As a result, the microservice and service instances may be messed, and dynamic configurations may be lost. Exercise caution when performing this operation.

  1. Click the target engine.
  2. In the Backup and Restoration area, click Restore in the Operation column of the row that contains the specified backup data.

    1. Select I have read and fully understand the risks.
    2. Click OK. To view the restoration status, click Restoration History in the Backup and Restoration area.

Deleting Backup Data

  1. Click the engine whose backup data you want to delete.
  2. In the Backup and Restoration area, click Delete in the Operation column of the target backup data. In the displayed dialog box, enter DELETE and click OK.