Updated at: 2022-02-24 GMT+08:00

Querying a Specified Version Package

Typical Scenario

Before upgrading the device version, an NA can call this API to query the target version upgrade package to ensure that it has been uploaded to the IoT platform.

API Function

This API is used by an NA to query a specified version package based on the version package ID on the IoT platform. The version package ID can be obtained by calling the API for querying a version package list.

API Description

1
QueryUpgradePackageOutDTO queryUpgradePackage(String fileId, String accessToken) throws NorthApiException

Parameter Description

Parameter

Mandatory or Optional

Type

Location

Description

fileId

Mandatory

String

path

Identifies a version package. The value of this parameter is obtained after the version package is uploaded.

accessToken

Mandatory

String

header

If the Periodically Refreshing a Token API is called, set this parameter to null. Otherwise, set this parameter to the accessToken obtained by the Authentication API.

Response Parameters

QueryUpgradePackageOutDTO structure

Parameter

Type

Description

fileId

String

Identifies a version package.

name

String

Indicates the version package name.

version

String

Indicates the version of the version package.

fileType

String

Indicates the type of a version package.

  • firmwarePackage: Indicates a firmware package.
  • softwarePackage: Indicates a software package.

deviceType

String

Indicates the type of the device to which the version package is applicable.

model

String

Indicates the model of the device to which the version package is applicable.

manufacturerName

String

Indicates the manufacturer of the device to which the version package is applicable.

protocolType

String

Indicates the protocol used by the device to which the version package is applicable.

description

String

Indicates the version package description.

date

String

Indicates the date on which the version package was generated.

uploadTime

String

Indicates the date on which the version package was uploaded.

Error Codes

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.

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

123002

Device or package file not found.

The device or package does not exist.

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

close