本文导读

展开导读

文档首页/ IoT物联网/ SDK参考/ 应用侧JAVA SDK API参考（联通用户专用）/ 设备升级/ 查询升级任务列表

查询升级任务列表

更新时间：2024-07-01 GMT+08:00

查看PDF

典型场景

第三方应用可调用此接口查询已创建的升级任务列表信息，以了解当前已有的升级任务信息及各个任务的执行情况。

接口功能

支持第三方应用在物联网平台查询升级任务的列表信息，可根据条件查询满足要求的升级任务信息。

接口描述

    
       QueryUpgradeTaskListOutDTO queryUpgradeTaskList(QueryUpgradeTaskListInDTO qutlInDTO, String accessToken) throws NorthApiException

参数说明

参数	必选/可选	类型	位置	描述
qutlInDTO	必选	QueryUpgradeTaskListInDTO	query	见下表QueryUpgradeTaskListInDTO的描述。
accessToken	必选	String	header	如果调用了定时刷新token接口，此参数值可以填写null，否则要填写鉴权接口获取的accessToken。

QueryUpgradeTaskListInDTO

参数	必选/可选	类型	位置	描述
operationType	可选	String(256)	query	操作类型。 firmware_upgrade software_upgrade
operationStatus	可选	String(256)	query	操作任务的状态。 wait：等待 processing：正在执行 failed：失败 success：成功 stop：停止
deviceType	可选	String(256)	query	操作任务针对的设备类型。
model	可选	String(256)	query	操作任务针对的设备型号。
manufacturerName	可选	String(256)	query	操作任务针对的设备厂家名称。
deviceId	可选	String(256)	query	操作任务针对的设备ID。
pageNo	可选	Integer	query	分页查询参数，默认值0。值为空时，查询内容不分页。值为大于等于0的整数时，分页查询。值为0时查询第一页。
pageSize	可选	Integer	query	查询结果分页时的每页结果数量，取值范围1-100，默认值10。

响应参数

QueryUpgradeTaskListOutDTO

参数	类型	描述
data	List<OperationInfo>	任务列表信息，具体参见OperationInfo结构体。
pageNo	Integer	查询结果的页码。
pageSize	Integer	查询结果每页的记录数量。
totalCount	Integer	查询结果的总记录数。

OperationInfo结构体说明：

参数	类型	描述
operationId	String	操作任务ID。
createTime	String	操作任务的创建时间。
startTime	String	操作任务的启动时间。
stopTime	String	操作任务的停止时间。
operateType	String	操作类型。 firmware_upgrade software_upgrade
targets	OperateDevices	执行操作的目标设备，具体参见OperateDevices结构体。
policy	OperatePolicy	操作执行策略，具体参见OperatePolicy结构体。
status	String	操作任务的状态。 wait：等待 processing：正在执行 failed：失败 success：成功 stop：停止
staResult	OperationStaResult	操作结果统计，具体参见OperationStaResult结构体。
extendPara	JsonString	操作扩展参数，视不同类型的操作不同。

OperateDevices结构体说明：

参数	类型	描述
deviceGroups	List<String>	设备组名称列表，最多支持256个设备组。与指定设备列表方式二选一。
deviceType	String	设备类型。指定设备组时，此字段必选。
model	String	设备型号。指定设备组时，此字段必选。
manufacturerName	String	设备厂商名称。指定设备组时，此字段必选。
devices	List<String>	设备ID列表，最多支持256个设备。与指定设备组方式二选一。

OperatePolicy结构体说明：

参数	类型	描述
executeType	String	执行类型，默认值为now。 now：现在执行 device_online：设备上线时执行 custom：自定义
startTime	String	任务执行时间，executeType=custom时必选，时间格式：yyyyMMdd'T'HHmmss'Z'，如：20151212T121212Z。
endTime	String	任务停止时间，executeType=custom时必选，时间格式：yyyyMMdd'T'HHmmss'Z'，如：20151212T121212Z。
retryType	Boolean	执行失败是否进行重试，默认不重试。 true：重试 false：不重试
retryTimes	Integer	重试次数, 取值范围1-5，retryType=true时必选。

OperationStaResult结构体说明：

参数	类型	描述
total	Integer(64)	操作设备总数。
wait	Integer(64)	等待操作的设备个数。
processing	Integer(64)	正在操作的设备个数。
success	Integer(64)	操作设成功的设备个数。
fail	Integer(64)	操作失败的设备个数。
stop	Integer(64)	停止操作的设备个数。
timeout	Integer(64)	操作超时失败的设备个数。

错误码

Http状态码	错误码	错误描述	说明
400	120015	Bad request error.	请求错误。处理建议：请检查接口请求中fileId的格式是否正确。
400	123029	pageNo or pageSize beyond the limit.	pageNo或pageSize超出上限。处理建议：修改pageNo或pageSize为合法取值。
403	1010009	app throttle exceed.	应用调用接口过于频繁，超过流控值（默认值是100次/60s）。处理建议：联系物联网平台维护人员调大流控阈值或者控制接口的调用频率。
403	1010005	Invalid access token or appId.	错误的token信息。处理建议：请检查接口请求中所携带的accessToken是否有误。
404	123009	The requested task does not exist.	查询的任务不存在。处理建议：请检查接口请求中的operationId内容是否正确。

父主题： 设备升级

上一篇：查询指定升级任务子任务详情

下一篇：应用侧Python SDK API参考（联通用户专用）

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

查询升级任务列表

典型场景

接口功能

接口描述

参数说明

响应参数

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线

文档反馈