设备接入 IoTDA设备接入 IoTDA

更新时间:2021/09/06 GMT+08:00
分享

查询升级任务列表

典型场景

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

接口功能

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

接口描述

1
def queryUpgradeTaskList(self, qutlInDTO, accessToken)

参数说明

参数

必选/可选

类型

位置

描述

qutlInDTO

必选

QueryUpgradeTaskListInDTO

query

见下表QueryUpgradeTaskListInDTO的描述。

accessToken

必选

String

header

填写鉴权接口获取的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内容是否正确。

分享:

    相关文档

    相关产品