Purchase and view available over-the-air (OTA) update attempts

Updated at:

IoT Platform limits the number of over-the-air (OTA) updates for Standard and Premium instances. Successful device OTA updates consume update attempts. IoT Platform provides packages that allow you to purchase OTA update attempts in advance. This topic describes how to purchase and use packages for OTA update attempts.

Features

You can purchase packages for Standard and Premium Enterprise instances in all regions where IoT Platform is available.

Usage notes

  • Enterprise instances include a free quota of 1,000 attempts per calendar month. The free quota is used first. After the free quota is used up, you must purchase a package to obtain more OTA update attempts.

    Important
    • A calendar month is from 00:00 on the first day of the month to 23:59:59 on the last day of the month.

    • The free quota is always used first. The unused free quota from a calendar month does not carry over to the next month.

  • New public instances include a free quota of 10 attempts per calendar month. After the free quota is used up, you must upgrade the new public instance to an Enterprise instance to purchase and use packages.

    For more information, see Upgrade a new public instance to an Enterprise instance.

    Important

    After you upgrade a new public instance to an Enterprise instance, the number of OTA update attempts for the current month does not increase immediately. The quota will be upgraded to 1,000 attempts per calendar month at 00:00 on the first day of the next month.

  • You do not need to purchase packages for old public instances.

    Old public instances use the pay-as-you-go billing method. You are charged based on the number of successful OTA updates. For more information, see OTA update billing.

How update attempts are calculated

The number of OTA update attempts is calculated using the following formula: (CEILING(OTA update package size / 100 MB)) × Number of successfully updated devices.

When you start a device OTA update, IoT Platform pre-deducts the required number of update attempts, assuming all specified devices will update successfully. The corresponding number of attempts are consumed for successful device OTA updates. If a device fails to update, for example, because the update task failed or was canceled, the pre-deducted attempts for that device are returned.

View statistics for OTA update attempts

You can view the statistics for OTA update attempts for your instance to ensure that you have enough attempts for successful device OTA updates.

  1. Log on to the IoT Platform console.

  2. In the upper-left corner of the console, select the region where your target Enterprise instance is located. On the Instance Overview page, select the target environment, find the Enterprise instance, and then click the instance name.

  3. On the Instance Details page, click the OTA Update tab.

  4. View the usage details for your current OTA update attempts. This includes statistics for the free quota and packages.

    Features

    Description

    Update Package Overview

    Displays statistics for the Number of Packages, usage of the Free Quota, Package Usage, and remaining Available Attempts. A donut chart shows a summary of the statistics.

    Click Alert Settings on the right. In the Cloud Monitor console, set a threshold-based alert rule for the number of OTA update attempts as needed. For more information, see Create a threshold-based alert rule.

    Package List

    Displays purchased packages, including Package ID, Used/Total, and Expired At.

    The package list is sorted by Expired At from latest to earliest. Expired packages are marked with an Expired tag.

    Usage Details Query

    Lets you query device OTA update information from the last six months. This includes Update Date, Update Package Name, Number of Successfully Updated Devices, and Deducted Attempts.

Create a threshold-based alert rule

Follow these steps to configure an alert rule for the number of available OTA update attempts. For more information, see Create an alert rule.

  1. In the Cloud Monitor console, on the Alert Service > Alert Rules page, click Create Alert Rule.

  2. In the Create Alert Rule panel, configure the alert rule.

    1. Select the associated IoT Platform resource.

      Parameter

      Configuration

      Product

      Select IoT Platform - Instance.

      Resource Scope

      Select Instance.

      Associated Resource

      Select one or more IoT Platform instances to monitor.

    2. Configure the rule.

      1. Click Add Rule.

      2. In the Add Rule Description panel, set the rule name, metric type, metric, threshold, alert level, and notification method.

        Set Metric to Device Upgrade Available Attempts Alert. You can customize the rule name, threshold, and alert level.

        In this example, the Critical threshold is Count <= 10, the Warning (Warn) threshold is Count <= 50, and the Info threshold is Count <= 60. The alert is triggered if the condition persists for three consecutive periods (1 period = 1 minute). The notification methods are as follows: Critical: phone call, text message, email, and WebHook. Warning: text message, email, and WebHook. Info: email and WebHook.

      3. Click OK.

    3. Configure the alert notification method. Set parameters such as the mute period, effective period, and alert contact group.

      In this example, Mute For is set to 12 hours, Effective Period is set to 00:00 to 23:59, and an existing contact group is selected for the Alert Contact Group.

  3. Click Confirm.

Formulas for used and deducted attempts

  • Used attempts: The number of pre-deducted attempts. This is calculated as follows: (CEILING(OTA update package size / 100 MB)) × Number of selected devices.

    If a device fails to update or the update task is canceled, the corresponding OTA update attempts are returned to the package.

  • Deducted Attempts: The number of consumed OTA update attempts. This is calculated as follows: (CEILING(OTA update package size / 100 MB)) × Number of successfully updated devices.

Example of logic for used and deducted attempts

image

Purchase a package

If you do not have enough available OTA update attempts for your instance, you can purchase a package to obtain more.

  1. In the IoT Platform console, go to your instance. In the navigation pane on the left, choose Monitoring and O&M > OTA Update.

  2. On the OTA Update page, click Purchase Package in the upper-right corner.

  3. On the purchase page, select the specifications.

    Parameter

    Description

    Region

    You can select:

    • China: China (Beijing), China (Shenzhen), and China (Shanghai).

    • Asia-Pacific: Singapore, Japan (Tokyo).

    • Europe and Americas: Germany (Frankfurt), US (Virginia), US (Silicon Valley).

    Attach Enterprise Instance

    Click the drop-down list and select the target Enterprise instance.

    Feature Module

    This is fixed to OTA Feature.

    Specification Quantity

    You can select: 10,000 attempts, 50,000 attempts, 100,000 attempts, 500,000 attempts, or 1,000,000 attempts.

    Quantity

    The default value is 1. The maximum value is 50. If you need more packages, you can make multiple purchases.

    Duration

    This is fixed to 1 Year.

  4. Follow the on-screen instructions to complete the purchase.

Note
  • Unused attempts from a package are not refundable and do not carry over to the next year.

  • Packages are not renewable. To add more resources, you must purchase a new package.