调用该接口获取某一个设备的固件升级信息,需要指定具体的固件版本号。如果存在相应的固件,返回当前固件的升级进度等信息。

路径 /thing/ota/progress/getByUser
版本号 1.0.2
协议 HTTP,HTTPS
请求方法 POST
是否需要用户身份鉴权
超时时间 15000

请求参数

名称 类型 是否必选 示例值 描述
iotId String 设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。
version String 对应的固件版本号。

返回数据

名称 类型 示例值 描述
iotId String

设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。

step Int

升级进度或升级错误信息。负数时,表示升级错误信息:-1(表示升级操作失败)-2(表示固件文件下载失败)-3(表示固件文件校验失败);-4(表示固件文件烧写失败)。非负数时表示升级进度,单位为:百分比。

desc String

描述信息。

success Boolean

是否成功标记。true(表示固件升级操作成功);false(表示升级未完成,包括正在升级或升级失败)。请优先选择upgradeStatus参数来判断固件升级状态。

needConfirm Boolean

是否需要用户进行确认操作。

upgradeStatus Int

当前升级状态。0(表示待升级或待确认);1(表示升级中);2(表示升级异常);3(表示升级失败);4(表示升级成功)。

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.2",
		"iotToken": "token"
	},
	"params":{
		"iotId": "value0",
		"version": "value1"
	}
}

正常返回示例

JSON 格式

{
    "id": "94e0871c-0770-xxxx-xxxx-e840d86b3ba6",
    "code": 200,
    "data": {
        "iotId": "xxxx",
        "step": 10,
        "desc": "xxxxxx",
        "success": false,
        "needConfirm": true,
        "upgradeStatus": 0
    }
}

异常返回示例

JSON 格式

{}