Help Center > > API Reference> Northbound PHP SDK API Reference> Service API List> Device Upgrade> Querying an Upgrade Task List

Querying an Upgrade Task List

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

Typical Scenario

An NA can call this API to query the created upgrade tasks to view the detailed information and execution status of each upgrade task.

API Function

This API is used by an NA to query details about upgrade tasks that meet specified conditions.

API Description

1
public function queryUpgradeTaskList($qutlInDTO, $accessToken)

Parameter Description

Parameter

Mandatory or Optional

Location

Description

$qutlInDTO

Mandatory

query

For details, see QueryUpgradeTaskListInDTO structure.

$accessToken

Mandatory

header

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

QueryUpgradeTaskListInDTO

Parameter

Mandatory or Optional

Location

Description

$operationType

Optional

query

Indicates the operation type.

  • firmware_upgrade
  • software_upgrade

$operationStatus

Optional

query

Indicates the status of the operation task.

  • wait: The operation task is waiting to be executed.
  • processing: The operation task is being executed.
  • failed: The operation task fails to be executed.
  • success: The operation task is successfully executed.
  • stop: The operation task stops being executed.

$deviceType

Optional

query

Indicates the device type for which the operation task is intended.

$model

Optional

query

Indicates the device model for which the operation task is intended.

$manufacturerName

Optional

query

Indicates the manufacturer of the device for which the operation task is intended.

$deviceId

Optional

query

Identifies the device for which the operation task is intended.

$pageNo

Optional

query

Indicates the page number. Default value: 0

  • 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 number of records on each page. The value ranges from 1 to 100. The default value is 10.

Response Parameters

QueryUpgradeTaskListOutDTO

Parameter

Description

$data

Indicates the task list. For details, see OperationInfo structure.

$pageNo

Indicates the page number.

$pageSize

Indicates the number of records to be displayed on each page.

$totalCount

Indicates the total number of query results.

OperationInfo structure

Parameter

Description

$operationId

Identifies an operation task.

$createTime

Indicates the time when the operation task was created.

$startTime

Indicates the time when the operation task was started.

$stopTime

Indicates the time when the operation task was stopped.

$operateType

Indicates the operation type.

  • firmware_upgrade
  • software_upgrade

$targets

Indicates the target devices on which the operation task is performed. For details, see OperateDevices structure.

$policy

Indicates the execution policy of the operation task. For details, see OperatePolicy structure.

$status

Indicates the status of the operation task.

  • wait: The operation task is waiting to be executed.
  • processing: The operation task is being executed.
  • failed: The operation task fails to be executed.
  • success: The operation task is successfully executed.
  • stop: The operation task stops being executed.

$staResult

Indicates operation result statistics. For details, see OperationStaResult structure.

$extendPara

Indicates extended information of the operation task. The value of this parameter varies depending on the operation type.

OperateDevices structure

Parameter

Description

$deviceGroups

Indicates the device group name list. A maximum of 256 device groups are supported.

Either this parameter or devices must be specified.

$deviceType

Indicates the device type.

This parameter must be specified when a device group is specified.

$model

Indicates the device model.

This parameter must be specified when a device group is specified.

$manufacturerName

Indicates the manufacturer name.

This parameter must be specified when a device group is specified.

$devices

Indicates the device ID list. A maximum of 256 devices are supported.

Either this parameter or deviceGroups must be specified.

OperatePolicy structure

Parameter

Description

$executeType

Indicates the execution type. The default value is now.

  • now: The upgrade task is executed now.
  • device_online: The upgrade task is executed when a device goes online.
  • custom: The execution type is customized.

$startTime

Indicates the start time of the operation task. This parameter must be specified when executeType is set to custom. The value is in the format of yyyyMMdd'T'HHmmss'Z'. An example value is 20151212T121212Z.

$endTime

Indicates the end time of the operation task. This parameter must be specified when executeType is set to custom. The value is in the format of yyyyMMdd'T'HHmmss'Z'. An example value is 20151212T121212Z.

$retryType

Indicates whether the platform retries the task upon an execution failure. The default value is false.

  • true: Retry is performed.
  • false: The platform does not retry the task.

$retryTimes

Indicates the number of retries. The value ranges from 1 to 5. This parameter must be specified when retryType is set to true.

OperationStaResult structure

Parameter

Description

$total

Indicates the number of operated devices.

$wait

Indicates the number of devices waiting to be operated.

$processing

Indicates the number of devices that are being operated.

$success

Indicates the number of devices that are operated successfully.

$fail

Indicates the number of devices that fail to be operated.

$stop

Indicates the number of devices that stop being operated.

$timeout

Indicates the number of devices that fail to be operated due to a timeout.

Error Code

HTTP Status Code

Error Code

Error Description

Remarks

400

120015

Bad request error.

A request error occurs.

Recommended handling: Check whether the format of fileId carried in the API request is correct.

400

123029

pageNo or pageSize beyond the limit.

The value of pageNo or pageSize exceeds the upper limit.

Recommended handling: Change the value of pageNo or pageSize to a valid value.

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

123009

The requested task does not exist.

The queried task does not exist.

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

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