OTA批次设备

大约 3 分钟

OTA批次设备

OTA 批次设备记录升级批次内每台设备的升级明细（进度、状态、失败原因）。批次创建与管理见固件升级。

查询批次设备分页

GET	/admin-api/iot/ota-batch-device/page

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
pageNo	页码，从 1 开始,示例值(1)	query	false	int32
pageSize	每页条数，最大值为 1000,示例值(10)	query	false	int32
productKey	产品productKey	query	false	string
deviceName	设备唯一标识	query	false	string
firmwareId	固件id	query	false	long
batchId	批次id	query	false	long
status	升级状态，见下方枚举	query	false	string
currentUpgradePercent	升级百分比	query	false	string
createTime	创建时间时间范围	query	false	array[datetime]
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

status 枚举

值	含义
1	QUEUED，待推送
2	IN_PROGRESS，升级中
3	SUCCEEDED，升级成功
4	FAILED，升级失败
6	CONFIRM，待确认
7	NOTIFIED，已推送
8	CANCELED，已取消

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	分页数据	object
---total	返回结果条数	int
---list	返回数据列表	array
------id	记录id	long
------productKey	产品productKey	string
------deviceName	设备唯一标识	string
------batchId	批次id	long
------jobId	任务id	int
------status	升级状态，见上方枚举	string
------statusDesc	状态描述（升级失败时为失败原因，如下载失败、校验失败）	string
------currentUpgradePercent	升级百分比	string
------createTime	创建时间	string
msg	状态消息	string

取消设备升级

PUT	/admin-api/iot/ota-batch-device/cancelUpdate

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
id	设备id	query	true	long
batchId	批次id	query	true	long
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	取消成功返回true	boolean
msg	状态消息	string

说明：仅「待推送（1）/ 升级中（2）/ 待确认（6）/ 已推送（7）」状态的设备可取消，取消后状态置为已取消（8）。

查询批次升级统计

GET	/admin-api/iot/ota-batch-device/statistics

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
batchId	批次id	query	true	long
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	统计数据	object
---allCount	设备总数	int
---queuedCount	待推送数量	int
---notifiedCount	已推送数量	int
---inProgressCount	升级中数量	int
---confirmCount	待确认数量	int
---succeededCount	升级成功数量	int
---failedCount	升级失败数量	int
---canceledCount	已取消数量	int
msg	状态消息	string

响应示例

{
  "status": 0,
  "code": 0,
  "data": {
    "allCount": 100,
    "queuedCount": 10,
    "notifiedCount": 5,
    "inProgressCount": 20,
    "confirmCount": 0,
    "succeededCount": 60,
    "failedCount": 3,
    "canceledCount": 2
  },
  "msg": ""
}

提示

设备「升级成功」的判定依据是设备通过 /ota/device/inform 上报的新版本与批次目标版本一致；进度接口 step=100 只表示进度。设备侧协议见OTA 升级。