查询批量任务的子任务信息
接口说明
应用服务器通过“创建批量任务”接口创建了设备的批量操作任务后，可调用此接口查询该批量任务中子任务的详情信息，如任务的执行状态、任务内容等。
URI
|
请求方法 |
GET |
|---|---|
|
URI |
/iocm/app/batchtask/v1.1.0/taskDetails |
|
传输协议 |
HTTP/HTTPS |
请求参数
|
参数 |
必选/可选 |
类型 |
位置 |
描述 |
|---|---|---|---|---|
|
app_key |
必选 |
String |
header |
访问物联网平台的应用ID，在物联网平台创建应用时由平台分配获得。 |
|
Authorization |
必选 |
String |
header |
访问物联网平台的认证信息，值为“Bearer {accessToken}”，其中{accessToken}为调用鉴权接口返回的accessToken。 |
|
appId |
可选 |
String |
query |
批量任务所属的应用ID，当查询授权应用下的批量任务时才需要填写。 |
|
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的整数。 |
|
pageSize |
可选 |
Integer |
query |
分页查询参数，查询结果分页显示时每页显示的记录数，默认值为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 |
不同任务类型的具体参数。 |
|
参数 |
类型 |
描述 |
|---|---|---|
|
deviceId |
String |
设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。 |
|
commandId |
String |
下发的命令ID，用于唯一标识一条命令，在下发设备命令时由物联网平台分配获得。 |
请求示例
GET https://{host}:{port}/iocm/app/batchtask/v1.1.0/taskDetails?appId=********&taskId=******&status=******&pageNo=******&pageSize=******
Content-Type: application/json
app_key: ******
Authorization: Bearer ******
正常响应示例
Status Code: 200 OK
Content-Type: application/json
{
"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. |
应用不存在。 处理建议：
|
|
403 |
100217 |
The application hasn't been authorized |
应用未被授权。 处理建议：若非应用授权场景，请确认请求参数中的appId为空。 |
|
403 |
1010009 |
app throttle exceed. |
应用调用接口过于频繁，超过流控值（默认值是100次/60s）。 处理建议：联系物联网平台维护人员调大流控阈值或者控制接口的调用频率。 |
|
403 |
1010005 |
Invalid access token or appId. |
错误的token信息。 处理建议：请检查接口请求中所携带的accessToken是否有误。 |
|
404 |
105005 |
The batchTask is not existed. |
批量任务不存在。 处理建议：请检查接口请求中的taskId是否有误。 |
|
500 |
100203 |
The application is not existed. |
应用不存在。 处理建议：
|
|
500 |
50252 |
Internal server error. |
服务器运行内部错误。 处理建议：物联网平台内部错误，请联系物联网平台维护人员处理。 |
