文档首页/ IoT物联网/ API参考/ 北向API参考/ 设备升级/ 查询指定任务信息
更新时间：2022-02-24 GMT+08:00
查看PDF
分享

查询指定任务信息

典型场景

在创建了设备软件升级任务或固件升级任务后，应用服务器可调用此接口查询某个升级任务详细信息，以查看升级任务的配置信息和执行情况等。

接口功能

支持应用服务器在物联网平台查询单个固件或软件升级任务的详细信息，包括升级任务的配置信息和执行情况等。

接口原型

请求方法

GET

请求地址

https://server:port/iodm/northbound/v1.5.0/operations/{operationId}

传输协议

HTTPS

请求参数

参数

必选/可选

类型

位置

描述

app_key

必选

String

header

访问物联网平台的应用ID，在物联网平台创建应用时由平台分配获得。

Authorization

必选

String

header

访问物联网平台的认证信息，值为“Bearer {accessToken}”，其中{accessToken}为调用鉴权接口返回的accessToken。

operationId

必选

String

path

操作任务ID，在创建操作任务后由物联网平台返回获得。

响应参数

Status Code: 200 OK

参数

类型

描述

operationId

String

操作任务ID。

createTime

String

操作任务的创建时间，时间格式：yyyyMMdd'T'HHmmss'Z'，如 20151212T121212Z。。

startTime

String

操作任务的启动时间，时间格式：yyyyMMdd'T'HHmmss'Z'，如 20151212T121212Z。。

stopTime

String

操作任务的停止时间，时间格式：yyyyMMdd'T'HHmmss'Z'，如 20151212T121212Z。。

operateType

String

操作类型。

  • firmware_upgrade
  • software_upgrade

targets

OperateDevices

执行操作的目标设备。

policy

OperatePolicy

操作执行策略。

status

String

操作任务的状态。

  • wait：等待
  • processing：正在执行
  • failed：失败
  • success：成功
  • stop：停止

staResult

OperationStaResult

操作结果统计。

extendPara

Map<String, String>

操作扩展参数，视不同类型的操作不同。

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)

操作超时失败的设备个数。

请求示例

Method: GET
request:
https://server:port/iodm/northbound/v1.5.0/operations/{operationId}
Header:
app_key: ******
Authorization: Bearer ******
Content-Type: application/json

响应示例

response:
Status Code: 200 OK
Content-Type: application/json
Body:
{
  "operationId": "**********",
  "createTime": "20151212T121212Z",
  "startTime": "20151212T121212Z",
  "stopTime": null,
  "operateType": "software_upgrade",
  "targets": {
    "deviceGroups": null,
    "deviceType": "******",
    "model": "******",
    "manufacturerName": "***",
    "devices": [
      "**********"
    ]
  },
  "policy": null,
  "status": "FAIL",
  "staResult": {
    "wait": 0,
    "processing": 0,
    "success": 0,
    "fail": 1,
    "stop": 0,
    "timeout": 0
  },
  "extendPara": {
    "fileVersion": "V1.1.10"
  }
}

错误码

Http状态码

错误码

错误描述

说明

400

120015

Bad request error.

请求错误。

处理建议：请检查接口请求中fileId的格式是否正确。

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内容是否正确。
父主题： 设备升级