IoT Platform:Back up a device data source

Prerequisites

You have an Enterprise Edition instance of IoT Platform. For more information, see Purchase an Enterprise instance.

Limitations

After you enable device data backup, only real-time data reported by devices of a specified product is backed up. Historical Thing Specification Language (TSL) data reported by using the /sys/${productKey}/${deviceName}/thing/event/property/history/post topic is not backed up.

Back up an instance

The first time you enable backup for an instance, you must set its backup cycle and select the products to back up. Newly added products inherit the instance-level backup duration by default. If you modify a product's backup duration, the product-level setting takes precedence.

1. In the IoT Platform console, go to the Overview page and click the ID or alias of the target Enterprise Edition instance.

2. In the left-side navigation pane, choose Data Service > Data Access. Click the Instance tab to view an overview of all instance data, including instance status, backup status, and backup cycle.

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

   1. The first time you enable instance backup, a dialog box appears. Configure the parameters in the following table and click OK .

   2. Subsequently, when you enable instance backup, a dialog box does not appear, and products within the instance are not automatically backed up. You must click View to go to the Backup Products page to select the products to back up and their backup duration.

      Parameter	Description
      Backup Type	The value is fixed to Same Region.
      Backup Cycle	Valid values: 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, and Never Expire. Important A backup cycle of one month is 30 days, and one year is 365 days.
      Select Products	Part of Products: In the product list, select the checkbox next to each product you want to back up. All Products: Backs up all products within the current instance. Specify whether to automatically enable device data backup for new products: By default, the Automatic Backup of New Products checkbox is selected, which automatically enables data backup for new products. If you clear the Automatic Backup of New Products checkbox, data backup is not automatically enabled for new products.

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

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

   • Edit: Modify the Backup Duration and the Automatic Backup of New Products setting.

   • Stop Instance Backup: Before you can stop the backup for an instance, you must first stop the backups for all products within that instance.

Back up a product

If you did not select Automatic Backup of New Products when setting up instance backup, you can still back up individual products later. Make sure instance backup is enabled, then enable backup for the product. Product-level backup settings take precedence over instance-level settings when they conflict.

1. In the left-side navigation pane of the IoT Platform console, choose Data Service > Data Access.

2. On the Instance tab, find the instance that contains the product you want to back up, and click View in the Actions column.

3. On the Backup Products page, find the target product.

   • To back up a single product: Click Enable Product Backup in the Actions column.

   • To back up multiple products: Select the checkboxes next to the product names and click Enable Product Backup below the list.

4. Optional: On the Backup Products page, find the target product.

   • To stop backing up a single product: Click Stop Product Backup in the Actions column.

   • To stop backing up multiple products: Select the checkboxes next to the product names and click Stop Product Backup below the list.

View backup details

1. In the left-side navigation pane, choose Data Service > Data Access. On the Instance tab, find the target instance in the instance list and click View. On the Backup Products page, view the Backup Status of all products within that instance.

   You can filter products by instance name or backup cycle from the drop-down lists, or by entering a product name in the search box.

   You can also select products and click Selected in the upper-right corner to display only the selected products.

2. In the Backup Products list, find the target product and click View in the Actions column.

   On the Product Details page, you can view basic product information and backup details. You can also click Data Retrieval to retrieve historical data for devices within the product. For more information, see Retrieve device data by product.

   Note

   You can retrieve up to 30 days of historical device data.

   The Product Details page contains the following information. Basic product information includes ProductKey, node type, Product Added Time, Category, Data Format, Activated/Total Devices, and Network Method. Backup information includes Backup Type (such as Same Region), Backup Cycle (such as 6 Months), Backup Status (Running), Last Backup Time, and Cumulative Storage.

Next steps

After device data is backed up, you can use it with the following IoT Platform data services:

• Data Parsing

• Offline Data Storage

• Data Metrics