查询指定升级任务结果
典型场景
在创建了设备软件升级任务或固件升级任务后，第三方应用可调用此接口查询某个升级任务详细信息，以查看升级任务的配置信息和执行情况等。
接口功能
支持第三方应用在物联网平台查询单个固件或软件升级任务的详细信息，包括升级任务的配置信息和执行情况等。
接口描述
1 |
public function queryUpgradeTask($operationId, $accessToken)
|
参数说明
参数 |
必选/可选 |
位置 |
描述 |
|---|---|---|---|
$operationId |
必选 |
path |
操作任务ID，在创建操作任务后由物联网平台返回获得。 |
$accessToken |
必选 |
header |
填写鉴权接口获取的accessToken。 |
响应参数
QueryUpgradeTaskOutDTO
参数 |
描述 |
|---|---|
$operationId |
操作任务ID。 |
$createTime |
操作任务的创建时间。 |
$startTime |
操作任务的启动时间。 |
$stopTime |
操作任务的停止时间。 |
$operateType |
操作类型。
|
$targets |
执行操作的目标设备，具体参见OperateDevices结构体。 |
$policy |
操作执行策略，具体参见OperatePolicy结构体。 |
$status |
操作任务的状态。
|
$staResult |
操作结果统计，具体参见OperationStaResult结构体。 |
$extendPara |
操作扩展参数，视不同类型的操作不同，具体参见extendPara请求参数。 |
参数 |
描述 |
|---|---|
$deviceGroups |
设备组名称列表，最多支持“256”个设备组。 与指定设备列表方式二选一。 |
$deviceType |
设备类型。 指定设备组时，此字段必选。 |
$model |
设备型号。 指定设备组时，此字段必选。 |
$manufacturerName |
设备厂商名称。 指定设备组时，此字段必选。 |
$devices |
设备ID列表，最多支持“256”个设备。 与指定设备组方式二选一。 |
参数 |
描述 |
|---|---|
$executeType |
执行类型，默认值为now。
|
$startTime |
任务执行时间，executeType=custom时必选，时间格式：yyyyMMdd'T'HHmmss'Z'，如：20151212T121212Z。 |
$endTime |
任务停止时间，executeType=custom时必选，时间格式：yyyyMMdd'T'HHmmss'Z'，如：20151212T121212Z。 |
$retryType |
执行失败是否进行重试，默认不重试。
|
$retryTimes |
重试次数, 取值范围1-5，retryType=true时必选。 |
参数 |
描述 |
|---|---|
$total |
操作设备总数。 |
$wait |
等待操作的设备个数。 |
$processing |
正在操作的设备个数。 |
$success |
操作设成功的设备个数。 |
$fail |
操作失败的设备个数。 |
$stop |
停止操作的设备个数。 |
$timeout |
操作超时失败的设备个数。 |
对于操作类型为softwareUpgrade和firmwareUpgrade，extendPara请求参数如下：
参数 |
描述 |
|---|---|
$fileVersion |
升级的目标版本号。 |
错误码
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 |
App_key or access_token is invalid. |
错误的token信息。 处理建议：请检查接口请求中所携带的accessToken是否有误。 |
404 |
123009 |
The requested task does not exist. |
查询的任务不存在。 处理建议：请检查接口请求中的operationId内容是否正确。 |
