OTA 升级

本文介绍 OTA 升级相关接口。

请求方式	API	描述
GET	/v1.0/devices/{device_id}/upgrade-infos	获取设备的升级信息。
PUT	/v1.0/devices/{device_id}/confirm-upgrade	确认设备升级。

获取设备的升级信息

接口描述

获取设备的升级信息。

接口地址

GET /v1.0/devices/{device_id}/upgrade-infos

请求参数

参数名	类型	参数类型	必填	说明
device_id	Long	URI	是	设备 ID
lang	String	URL	否	多语言

返回参数

参数名	类型	说明
code	Integer	错误码。
success	Boolean	是否成功： true：成功 false：失败
msg	String	请求失败的信息，成功为空。
result	List<result>	返回结果。

result

参数名	类型	说明
upgrade_status	Integer	升级状态： 0：不需要升级 1：硬件准备就绪 2：升级中 3：升级完成 4：升级异常
current_version	String	当前版本
upgrade_version	String	升级版本
module_type	String	模块类型： 0：Wi-Fi 1：蓝牙 2：GPRS 3：Zigbee 4：红外 5：433 网关 6：NB-IoT 9：MCU
module_desc	String	模块描述
last_upgrade_time	String	最近升级时间
upgrade_desc	String	升级描述文案

请求示例

GET /v1.0/devices/vedeo71y2387123/upgrade-infos

返回示例

{
    "success":true,
    "t":1541071460239,
    "result":[
        {
            "upgrade_status":0,
            "current_version":"",
            "upgrade_version":"",
            "module_type": 0,
            "module_desc":"",
            "last_upgrade_time": 1541071460236,
    	    "upgrade_desc":""
        }
    ]
}

错误码

以下为该接口常见的业务异常，更多的异常错误，请参见全局错误码。

错误码	说明
500	系统错误
1106	非法权限

确认设备升级

接口描述

确认设备升级。

接口地址

PUT /v1.0/devices/{device_id}/confirm-upgrade

请求参数

参数名	类型	参数类型	必填	说明
device_id	Long	URI	是	设备 ID
module_type	Integer	Body	是	模块类型

返回参数

参数名	类型	说明
code	Integer	错误码。
success	Boolean	是否成功： true：成功 false：失败
msg	String	请求失败的信息，成功为空。
result	Boolean	返回结果。

请求示例

PUT /v1.0/devices/deveo12y423323/confirm-upgrade

{
    "module_type": 1
}

返回示例

{
    "success":true,
    "t":1541071460239,
    "result": true
}

错误码

以下为该接口常见的业务异常，更多的异常错误，参见全局错误码。

错误码	说明
500	系统错误
1106	非法权限