Back up IoT Digital Twin Engine data sources

Updated at:
Copy as MD

You can enable backups for IoT Digital Twin Engine data sources in IoT Platform. IoT Platform stores the backup data in time-series tables and snapshot tables in cold storage. This topic describes how to back up your IoT Digital Twin Engine data sources.

Prerequisites

You have completed the following:

  1. You must purchase an Enterprise instance of IoT Platform. For more information, see Purchase an Enterprise instance.

  2. You have created a digital twin space for the IoT Digital Twin Engine. For more information, see Create a digital twin space.

Note
  • When you enable data backup, IoT Platform verifies the number of data processing units (CUs) for the purchased instance. If the number of CUs is insufficient, the operation fails.

  • For information about how to calculate data processing units (CUs), see Billable items.

Background information

For a detailed description and use cases of IoT Digital Twin Engine data sources, see Data ingestion overview.

Back up an instance

You can back up all IoT Digital Twin Engine data sources in an instance.

  1. On the Instance Overview page of the IoT Platform console, click the ID or alias of the target Enterprise instance.

  2. In the left-side navigation pane, choose Data Service > Data Ingestion, and click the IoT TDE tab.

    The IoT TDE tab provides an overview of all instance data, including instance status, backup status, and backup period.

  3. In the instance list, find the target instance and click Enable Instance Backup in the Actions column.

    1. If you are enabling instance backup for the first time, a dialog box appears. Configure the parameters in the dialog box and click Confirm.

    2. If you have previously enabled instance backup, no dialog box appears. Backups for products in the instance are not automatically enabled. Click View to go to the product backup page. Then, you can select the products to back up and set their backup duration.

      Parameter

      Description

      Backup Type

      Default is same-region. This cannot be modified.

      Backup Cycle

      Select 1 month, 2 months, 3 months, 4 months, 5 months, 6 months, 7 months, 8 months, 9 months, 1 year, 2 years, 3 years, 5 years, 10 years, or Never Expire.

      Important

      A 1-month backup cycle is calculated as 30 days. A 1-year backup cycle is calculated as 365 days.

      Select Products

      • Some Products: In the product list, select the check boxes of the target products to back up.

      • All Products: Back up all products under the current instance.

      Automatic backup for new products:

      • By default, the Automatically back up new products check box is selected. New products will have device data backup enabled automatically.

      • Clear the Automatically back up new products check box. New products will not have device data backup enabled automatically.

  4. Optional: After the backup completes successfully, find the target instance in the instance list and perform the following operations:

    • View: View the backup status and other information for all products in the instance.

    • Edit: Modify the Backup Duration and the Automatically back up new products option.

    • Stop Instance Backup: Before you stop the instance backup, you must stop the backups for all products in the instance.

Enable or disable space backup

If instance backup is enabled, you can disable or enable it for a specific digital twin space.

  1. In the navigation pane on the left of the IoT Platform console, choose DataService Studio > Data Ingestion.

  2. Click the IoT TDE tab, find the target instance, and then click View in the Actions column.

  3. In the Space List, find the target space and click Enable or Disable in the Actions column.

    You can also select the checkboxes next to the space names and click Enable or Disable below the list.

    Note

    You can click Disable only when the Backup Status is Running. You can click Enable only when the Backup Status is Stopped.

  4. Click OK.

View backup details

  1. In the left-side navigation pane, choose Data Service > Data Ingestion, and click the IoT TDE tab.

  2. In the instance list, find the target instance and click View.

    On the Space List page, view the Backup Status of all digital twin spaces in the instance.

    In the space list, select the checkbox next to a target space and click Selected in the upper-right corner of the list to display only the selected digital twin spaces. The table also displays information such as Backup period, Space creation time, and Backup start and end time. If the backup status is Running, click Disable in the Actions column.

Next steps

View time-series and snapshot tables in IoT Digital Twin Engine