查询批量任务的子任务信息
典型场景
第三方应用通过“创建批量任务”接口创建了设备的批量操作任务后,可调用此接口查询该批量任务中子任务的详情信息,如任务的执行状态、任务内容等。
接口功能
支持第三方应用根据条件查询批量任务中子任务的详情信息,支持查询本应用创建的批量任务信息。
接口描述
1 |
public function queryTaskDetails($qtdInDTO, $accessToken)
|
接口所属类
BatchProcess
参数说明
参数 |
必选/可选 |
位置 |
描述 |
---|---|---|---|
$qtdInDTO |
必选 |
query |
见下表QueryTaskDetailsInDTO的描述。 |
$accessToken |
必选 |
header |
填写鉴权接口获取的accessToken。 |
参数 |
必选/可选 |
位置 |
描述 |
---|---|---|---|
$appId |
可选 |
query |
如果是本应用的任务,此参数值可以填写null,否则填写授权应用的appId。 |
$taskId |
必选 |
query |
批量任务的ID。 |
$status |
可选 |
query |
任务的详情状态,“Pending/Success/Fail/Timeout”。 |
$index |
可选 |
query |
批量任务文件里第几行的任务,查询批量注册任务时使用。 |
$nodeId |
可选 |
query |
设备nodeId,查询批量注册任务时使用。 |
$deviceId |
可选 |
query |
设备Id,查询批量命令任务时使用。 |
$commandId |
可选 |
query |
命令Id,查询批量命令任务时使用。 |
$pageNo |
可选 |
query |
分页查询参数。
|
$pageSize |
可选 |
query |
分页查询参数,取值大于等于1的整数,缺省值:“1”。 |
返回值
QueryTaskDetailsOutDTO
参数 |
描述 |
---|---|
$pageNo |
分页查询参数。
|
$pageSize |
分页查询参数,取值大于等于1的整数,缺省值:“1”。 |
$totalCount |
查询到的任务总数。 |
$taskDetails |
任务详情信息(QueryTaskDetailDTOCloud2NA)列表。 |
参数 |
描述 |
---|---|
status |
任务执行状态,取值范围:Pending/WaitResult/Success/Fail/Timeout。 |
output |
批量下发命令的输出信息。 |
error |
任务的错误原因,格式为: {\"error_code\": \"****\", \"error_desc\":\"*****\"}。 |
param |
不同任务类型的具体参数,具体参见ObjectNode。 |
参数 |
描述 |
---|---|
deviceId |
设备ID,用于唯一标识一个设备,在注册设备时由物联网平台分配获得。 |
commandId |
下发的命令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. |
服务器运行内部错误。 处理建议:物联网平台内部错误,请联系物联网平台维护人员处理。 |