Help Center > > API Reference> Northbound PHP SDK API Reference> Service API List> Batch Processing> Querying Information About a Subtask of a Batch Task

Querying Information About a Subtask of a Batch Task

Updated at: Aug 28, 2019 GMT+08:00

Typical Scenario

After creating a batch task for devices, an NA can call this API to query information about a subtask of the batch task, including the subtask execution status and subtask content.

API Function

This API is used by an NA to query information about a subtask of a batch task based on specified conditions. This API applies to the current application.

API Description

1
public function queryTaskDetails($qtdInDTO, $accessToken)

Class

BatchProcess

Parameter Description

Parameter

Mandatory or Optional

Location

Description

$qtdInDTO

Mandatory

query

For details, see QueryTaskDetailsInDTO structure.

$accessToken

Mandatory

header

This parameter is set to the value of the access token obtained by calling the Authentication API.

QueryTaskDetailsInDTO

Parameter

Mandatory or Optional

Location

Description

$appId

Optional

query

If the task belongs to the current application, set this parameter to null. Otherwise, set this parameter to the ID of the authorized application.

$taskId

Mandatory

query

Identifies a batch task.

$status

Optional

query

Indicates the task status. The value options are Pending, Success, Fail, and Timeout.

$index

Optional

query

Indicates the index in a file. This parameter is used for querying details about a batch device registration task.

$nodeId

Optional

query

Uniquely identifies the device. This parameter is used for querying details about a batch device registration task.

$deviceId

Optional

query

Identifies a device. This parameter is used for querying details about a batch command delivery task.

$commandId

Optional

query

Identifies a command. This parameter is used for querying details about a batch command delivery task.

$pageNo

Optional

query

Indicates the page number.

  • If the value is null, pagination query is not performed.
  • If the value is an integer greater than or equal to 0, pagination query is performed.
  • If the value is 0, the first page is queried.

$pageSize

Optional

query

Indicates the page size. The value is an integer greater than or equal to 1. The default value is 1.

Return Value

QueryTaskDetailsOutDTO structure

Parameter

Description

$pageNo

Indicates the page number.

  • If the value is null, pagination query is not performed.
  • If the value is an integer greater than or equal to 0, pagination query is performed.
  • If the value is 0, the first page is queried.

$pageSize

Indicates the page size. The value is an integer greater than or equal to 1. The default value is 1.

$totalCount

Indicates the total number of records.

$taskDetails

Indicates the task details. For details, see QueryTaskDetailDTOCloud2NA structure.

QueryTaskDetailDTOCloud2NA structure

Parameter

Description

status

Indicates the task status. The value options are Pending, WaitResult, Success, Fail, and Timeout.

output

Indicates the output of a batch command delivery task.

error

Indicates the cause of error, in the format of {\"error_code\": \"****\", \"error_desc\":\"*****\"}.

param

Indicates the parameters of different types of tasks. For details, see ObjectNode.

ObjectNode:

Parameter

Description

deviceId

Uniquely identifies a device. The value of this parameter is allocated by the IoT platform during device registration..

commandId

Uniquely identifies a device command. The value of this parameter is allocated by the IoT platform during command delivery.

Error Codes

HTTP Status Code

Error Code

Error Description

Remarks

400

100022

The input is invalid

An input parameter is invalid.

Recommended handling: Check whether parameters carried in the API call request are valid.

403

100203

The application is not existed.

The application does not exist.

Recommended handling:

  • Check whether appId carried in the HTTP request header is correct.
  • Check whether appId in the request path (URL) is correct.

403

100217

The application hasn't been authorized

The application has not been authorized.

Recommended handling: In scenarios where applications are not authorized, ensure that request parameter appId is null.

403

1010009

app throttle exceed.

The NA calls the API at a frequency that exceeds the flow control threshold (100 calls per minute by default).

Recommended handling: Contact IoT platform maintenance personnel to adjust the flow control threshold or control the API call frequency.

403

1010005

App_key or access_token is invalid.

The access token is invalid.

Recommended handling: Check whether accessToken carried in the API request is correct.

404

105005

The batchTask is not existed.

The batch task does not exist.

Recommended handling: Check whether taskId carried in the API request is correct.

500

100203

The application is not existed.

The application does not exist.

Recommended handling:

  • Check whether appId carried in the HTTP request header is correct.
  • Check whether appId in the request path (URL) is correct.

500

50252

Internal server error.

An internal server error occurs.

Recommended handling: An internal error occurs on the IoT platform. Contact IoT platform maintenance personnel.

Did you find this page helpful?

Submit successfully!

Thank you for your feedback. Your feedback helps make our documentation better.

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?







Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel