Cloud Services API ReferenceIoT CoreDevice ManagementGet Update Information

Get Update Information

Last Updated on : 2023-11-23 06:29:13download

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

API address

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

Request parameter

Parameter name	Type	IN	Required	Description
device_id	String	uri	true	The device ID.

Return parameter

Parameter name	Type	Description
result	FusionResult	The returned result.

Description of result

Parameter name	Type	Description
success	Boolean	Indicates whether the operation is successful.
error_code	String	The error code.
error_msg	String	The error message.
result	List	The returned result.

Description of result

Parameter name	Type	Description
upgrade_status	Integer	The update status. Valid values: `0`: No update is going on. `1`: The device is ready. `2`: The update is in progress. `3`: The update is completed. `4`: An exception occurs during an update process. `7`: The update timed out.
current_version	String	The current version number of the firmware in the specified channel.
version	String	The target version number of the firmware in the specified channel after the OTA update.
desc	String	The description of the update.
upgrading_desc	String	The multilingual text when the firmware update is in progress.
downloading_desc	String	The multilingual text when the firmware download is in progress. Currently, this field only applies to NB-IoT devices.
waiting_desc	String	The text on the app when waiting for the device to wake up during firmware update of non-keep-alive devices.
dev_type	Integer	The type of device. Valid values: `0`: generic type of device. `1`: non-keep-alive device.
timeout	Integer	The update timeout period.
upgrade_type	Integer	The update method.
type	Integer	The firmware update channel.
type_desc	String	The description of the module type.
url	String	The URL field of the specified file. It applies to Bluetooth devices and more.
md5	String	The MD5 hash of the update file.
sign	String	The signature of the update file.
file_size	String	The file size.
last_upgrade_time	Long	The last update time.
firmware_deploy_time	Long	The time when the firmware was released.
control_type	Integer	Indicates whether the device is controllable during the update process. Valid values: `0`: not controllable. `1`: controllable.
can_upgrade	Boolean	Indicates whether the device can be updated if the data point conditions are met. Valid values: `0`: The device cannot be updated. `1`: The device can be updated.
remind	String	The multilingual reason why the device cannot be updated.

Request example

GET: /v2.0/cloud/thing/vdev1243432***/firmware

Return example

{
    "result": {
        "channel": 0,
        "current_version": "1.0.0",
        "version": "2.0.0",
        "upgrade_type": 1,
        "timeout": 60,
        "upgrade_status": 1,
        "type_desc": "Bluetooth",
        "desc": "Firmware update",
        "control_type": 0
    },
    "success": true
}

Error code

For more information, see error code.

Limits on API Request Frequency

For more information, see Limits on API Request Frequency.

Prev DocDelete Device

Next DocQuery Device Details