IoTIoT

Compute
Elastic Cloud Server
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
Domain Name Service
VPC Endpoint
Cloud Connect
Enterprise Switch
Security & Compliance
Anti-DDoS
Web Application Firewall
Host Security Service
Data Encryption Workshop
Database Security Service
Advanced Anti-DDoS
Data Security Center
Container Guard Service
Situation Awareness
Managed Threat Detection
Compass
Cloud Certificate Manager
Anti-DDoS Service
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GaussDB NoSQL
GaussDB(for MySQL)
Distributed Database Middleware
GaussDB(for openGauss)
Developer Services
ServiceStage
Distributed Cache Service
Simple Message Notification
Application Performance Management
Application Operations Management
Blockchain Service
API Gateway
Cloud Performance Test Service
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
DevCloud
ProjectMan
CodeHub
CloudRelease
CloudPipeline
CloudBuild
CloudDeploy
Cloud Communications
Message & SMS
Cloud Ecosystem
Marketplace
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP License Service
Support Plans
Customer Operation Capabilities
Partner Support Plans
Professional Services
enterprise-collaboration
Meeting
IoT
IoT
Intelligent EdgeFabric
DeveloperTools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Updated at: Feb 24, 2022 GMT+08:00

Querying a Version Package List

Typical Scenario

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

API Function

This API is used by an NA to query a list of uploaded version packages that meet a specified condition.

API Description

1
public function queryUpgradePackageList($quplInDTO, $accessToken)

Parameter Description

Parameter

Mandatory or Optional

Location

Description

$quplInDTO

Mandatory

query

For details, see QueryUpgradePackageListInDTO structure.

$accessToken

Mandatory

header

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

QueryUpgradePackageListInDTO

Parameter

Mandatory or Optional

Location

Description

$fileType

Optional

query

Indicates the type of a version package.

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

$deviceType

Optional

query

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

$model

Optional

query

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

$manufacturerName

Optional

query

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

$version

Optional

query

Indicates the version of the version package.

$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

QueryUpgradePackageListOutDTO

Parameter

Description

$data

Indicates the version package list. For details, see QueryUpgradePackageOutDTO 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.

QueryUpgradePackageOutDTO structure

Parameter

Description

$fileId

Identifies a version package.

$name

Indicates the version package name.

$version

Indicates the version of the version package.

$fileType

Indicates the type of a version package.

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

$deviceType

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

$model

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

$manufacturerName

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

$protocolType

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

$description

Indicates the version package description.

$date

Indicates the date on which the version package was generated.

$uploadTime

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 values of pageNo and pageSize in the API request are within the valid ranges.

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.

Did you find this page helpful?

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