Get Update Progress

Last Updated on : 2023-11-23 06:27:28download

Get the update progress of the specified device based on the device ID.

API address

GET: /v2.0/cloud/thing/{device_id}/firmware/{channel}/progress

Request parameter

Parameter nameTypeINRequiredDescription
device_idStringuritrueThe device ID.
channelIntegeruritrueThe firmware update channel.

Return parameter

Parameter nameTypeDescription
resultFusionResultThe returned result.

Description of result

Parameter nameTypeDescription
successBooleanIndicates whether the operation is successful. Valid values:
  • true: The operation succeeded.
  • false: The operation failed.
error_codeStringThe error code.
error_msgStringThe error message.
resultFusionResultThe returned result.

Description of result

Parameter nameTypeDescription
progressIntegerThe progress of the firmware update.
upgrade_statusIntegerThe update status. Valid values:
  • 2: Update is in progress.
  • 3: Update succeeded.
  • 4: Update failed.
  • 7: Update timed out.

Request example

GET: /v2.0/cloud/thing/aab21***/firmware/0/progress

Return example

{
    "result": {
        "upgrade_status": 2,
        "progress": 30
    },
    "success": true
}

Error code

For more information, see error code.

Limits on API Request Frequency

For more information, see Limits on API Request Frequency.