文档首页/ IoT物联网/ API参考/ 北向API参考/ 批量处理/ 查询批量任务的子任务信息
更新时间：2022-02-24 GMT+08:00
查看PDF
分享

查询批量任务的子任务信息

典型场景

应用服务器通过“创建批量任务”接口创建了设备的批量操作任务后，可调用此接口查询该批量任务中子任务的详情信息，如任务的执行状态、任务内容等。

接口功能

支持应用服务器根据条件查询批量任务中子任务的详情信息。

接口原型

请求方法

GET

请求地址

https://server:port/iocm/app/batchtask/v1.1.0/taskDetails?appId={appId}&taskId={taskId}&status={status}&index={index}&deviceId={deviceId}&commandId={commandId}&pageNo={pageNo}&pageSize={pageSize}

传输协议

HTTP/HTTPS

请求参数

参数

必选/可选

类型

位置

描述

app_key

必选

String

header

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

Authorization

必选

String

header

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

appId

可选

String

query

访问物联网平台的应用ID，在物联网平台创建应用时由平台分配获得。此处填写授权应用的appId。

taskId

必选

String

query

批量任务的ID。

status

可选

String

query

任务的详情状态，Pending/WaitResult/Success/Fail/Timeout。

deviceId

可选

String

query

设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。

commandId

可选

String

query

设备命令ID，用于唯一标识一条命令，在下发设备命令时由物联网平台分配获得。

pageNo

可选

Integer

query

分页查询时指定要查询的页码信息，默认值为0，取值范围为大于等于0的整数，值为0时，查询第一页。

pageSize

可选

Integer

query

分页查询时每页显示的记录数，查询结果根据pageSize进行分页，默认值为25，取值范围为1-250的整数。

响应参数

Status Code: 200 OK

参数

类型

描述

pageNo

Long

查询的页码。

pageSize

Long

查询每页信息的数量。

totalCount

Long

查询到的任务总数。

taskDetails

List<QueryTaskDetailDTOCloud2NA>

任务详情信息列表。

QueryTaskDetailDTOCloud2NA：

参数

类型

描述

status

String

任务执行状态，取值范围：Pending/WaitResult/Success/Fail/Timeout。

output

String

批量下发命令的输出信息。

error

String

任务的错误原因，格式为： {\"error_code\": \"****\", \"error_desc\":\"*****\"}。

param

ObjectNode

不同任务类型的具体参数。

ObjectNode：

参数

类型

描述

deviceId

String

设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。

commandId

String

下发的命令ID，用于唯一标识一条命令，在下发设备命令时由物联网平台分配获得。

请求示例

Method: GET
request:
https://server:port/iocm/app/batchtask/v1.1.0/taskDetails?appId=********&taskId=******&status=******&pageNo=******&pageSize=******
Header:
app_key: ******
Authorization: Bearer ******
Content-Type: application/json

响应示例

response:
Status Code: 200 OK
Content-Type: application/json
Body:
{
  "totalCount": 1,
  "pageNo": 0,
  "pageSize": 1,
  "taskDetails": [
    {
      "status": "WaitResult",
      "output": "{\"requestId\":\"*****\",\"commandResult\":null}",
      "error": null,
      "param": {
        "deviceId": "*******",
        "commandId": "*******"
      }
    },
    {
      "status": "WaitResult",
      "output": "{\"requestId\":\"******\",\"commandResult\":null}",
      "error": null,
      "param": {
        "deviceId": "******",
        "commandId": "*******"
      }
    }
  ]
}

错误码

Http状态码

错误码

错误描述

说明

400

100022

The input is invalid

输入参数无效。

处理建议：请检查接口调用请求中携带参数的合法性。

403

100203

The application is not existed.

应用不存在。

处理建议：

  • 请检查HTTP请求头域中携带的appId是否有误。
  • 请检查请求路径（url）中传入的appId是否有误。

403

100217

The application hasn't been authorized

应用未被授权。

处理建议：若非应用授权场景，请确认请求参数中的appId为空。

403

1010009

app throttle exceed.

应用调用接口过于频繁，超过流控值（默认值是100次/60s）。

处理建议：联系物联网平台维护人员调大流控阈值或者控制接口的调用频率。

403

1010005

App_key or access_token is invalid.

错误的token信息。

处理建议：请检查接口请求中所携带的accessToken是否有误。

404

105005

The batchTask is not existed.

批量任务不存在。

处理建议：请检查接口请求中的taskId是否有误。

500

100203

The application is not existed.

应用不存在。

处理建议：

  • 请检查HTTP请求头域中携带的appId是否有误。
  • 请检查请求路径（url）中传入的appId是否有误。

500

50252

Internal server error.

服务器运行内部错误。

处理建议：物联网平台内部错误，请联系物联网平台维护人员处理。
父主题： 批量处理