查询批量任务的子任务信息
典型场景
第三方应用通过“创建批量任务”接口创建了设备的批量操作任务后，可调用此接口查询该批量任务中子任务的详情信息，如任务的执行状态、任务内容等。
接口功能
支持第三方应用根据条件查询批量任务中子任务的详情信息，支持查询本应用创建的批量任务信息。
接口描述
1 |
QueryTaskDetailsOutDTO queryTaskDetails(QueryTaskDetailsInDTO qtdInDTO, String accessToken) throws NorthApiException
|
接口所属类
BatchProcess
参数说明
参数 |
必选/可选 |
类型 |
位置 |
描述 |
|---|---|---|---|---|
accessToken |
必选 |
String |
header |
|
qtdInDTO |
必选 |
QueryTaskDetailsInDTO |
query |
详细参见QueryTaskDetailsInDTO结构体的描述。 |
参数 |
必选/可选 |
类型 |
位置 |
描述 |
|---|---|---|---|---|
appId |
可选 |
String |
query |
第三方应用的身份标识，用于唯一标识一个应用。开发者可通过该标识来指定哪个应用来调用物联网平台的开放API。appid在物联网平台的SP Portal上创建应用时获得。此处填写授权应用的appid。 |
taskId |
必选 |
String |
query |
批量任务的ID。 |
status |
可选 |
String |
query |
任务的详情状态，Pending/WaitResult/Success/Fail/Timeout。 |
deviceId |
可选 |
String |
query |
设备Id，查询批量命令任务时使用。 |
commandId |
可选 |
String |
query |
命令Id，查询批量命令任务时使用。 |
pageNo |
可选 |
Integer |
query |
分页查询参数。
|
pageSize |
可选 |
Integer |
query |
分页查询参数，取值大于等于1的整数，缺省值：1。 |
返回值
QueryTaskDetailsOutDTO
参数 |
类型 |
描述 |
|---|---|---|
pageNo |
Integer |
分页查询参数。
|
pageSize |
Integer |
分页查询参数，取值大于等于1的整数，缺省值：1。 |
totalCount |
Integer |
查询到的任务总数。 |
taskDetails |
List<QueryTaskDetailDTOCloud2NA> |
任务详情信息列表，具体参见QueryTaskDetailDTOCloud2NA结构体。 |
QueryTaskDetailDTOCloud2NA结构体说明：
参数 |
类型 |
描述 |
|---|---|---|
status |
String |
任务执行状态，取值范围：Pending/WaitResult/Success/Fail/Timeout。 |
output |
String |
批量下发命令的输出信息。 |
error |
String |
任务的错误原因，格式为： {\"error_code\": \"****\", \"error_desc\":\"*****\"}。 |
param |
不同任务类型的具体参数。 |
参数 |
类型 |
描述 |
|---|---|---|
deviceId |
String |
设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。 |
commandId |
String |
下发的命令ID，用于唯一标识一条命令，在下发设备命令时由物联网平台分配获得。 |
错误码
Http状态码 |
错误码 |
错误描述 |
说明 |
|---|---|---|---|
400 |
100022 |
The input is invalid |
输入参数无效。 处理建议：请检查接口调用请求中携带参数的合法性。 |
403 |
100203 |
The application is not existed. |
应用不存在。 处理建议：
|
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. |
应用不存在。 处理建议：
|
500 |
50252 |
Internal server error. |
服务器运行内部错误。 处理建议：物联网平台内部错误，请联系物联网平台维护人员处理。 |
