Query the OTA Upgrade Package List

Updated on 2023-11-08 GMT+08:00

View PDF

Function

This API is used to query upgrade packages associated with OBS objects. To use this API, grant IoTDA instances the permission to access OBS and the KMS Administrator permissions. On the IAM console, choose Agencies, locate the iotda_admin_trust agency, and grant KMS Administrator and OBS OperateAccess permissions to the agency.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v5/iot/{project_id}/ota-upgrades/packages

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description: project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
app_id	No	String	Parameter description: resource space ID. If you have multiple resource spaces, you can use this parameter to specify the resource space that the upgrade packages to query belong to. Value: The value can contain a maximum of 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.
package_type	Yes	String	Parameter description: type of the upgrade package. Options: For a software package, set this parameter to softwarePackage. For a firmware package, set this parameter to firmwarePackage.
product_id	No	String	Parameter description: unique ID of the product associated with the device. The value is allocated by the platform after the product is created. For details, see Creating a Product. Value: The value can contain a maximum of 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.
version	No	String	Parameter description: version number of the upgrade package. Value: The value can contain a maximum of 256 characters. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.
limit	No	Integer	Parameter description: number of records to display on each page. Value: The value is an integer ranging from 1 to 50. The default value is 10. Minimum: 1 Maximum: 50 Default: 10
marker	No	String	Parameter description: ID of the last record in the previous query. The value is returned by the platform during the previous query. Records are queried in descending order of record IDs (the marker value). A newer record will have a larger ID. If marker is specified, only the records whose IDs are smaller than marker are queried. If marker is not specified, the query starts from the record with the largest ID, that is, the latest record. If all data needs to be queried in sequence, this parameter must be filled with the value of marker returned in the last query response each time. Value: The value is a string of 24 hexadecimal characters. The default value is ffffffffffffffffffffffff. Default: ffffffffffffffffffffffff
offset	No	Integer	Parameter description: If offset is set to N, the query starts from the N+1 record after the last record in the previous query. The value is an integer ranging from 0 to 500. The default value is 0. If offset is set to 0, the output starts from the first record after the last record in the previous query. To ensure API performance, you can use this parameter together with marker to turn pages. For example, if there are 50 records on each page, you can directly specify offset to jump to the specified page within page 1 and 11. If you want to view records displayed on pages 12 to 22, you need to use the marker value returned on page 11 as the marker value for the next query. Value: The value is an integer ranging from 0 to 500. The default value is 0. Minimum: 0 Maximum: 500 Default: 0

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	Parameter description: user token. You can obtain the token by calling the IAM API Obtaining a User Token Through Password Authentication. In the returned response header, X-Subject-Token is the desired user token. For details about how to obtain the token, see Token Authentication.
Instance-Id	No	String	Parameter description: instance ID. This parameter is required only when the API is called from the management plane in the physical multi-tenant scenario. You can log in to the IoTDA console and choose Overview in the navigation pane to view the instance ID.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
packages	Array of OtaPackageInfo objects	Upgrade package list.
page	PageInfo object	Response structure of the batch query result pagination. It defines page numbers, the number of records on each page, the total number of records, and ID of the last record on the current page.

**Table 5** OtaPackageInfo
Parameter	Type	Description
package_id	String	Parameter description: upgrade package ID, which uniquely identifies an upgrade package. The value is allocated by the IoT platform. Value: The value can contain a maximum of 36 characters. Only letters, digits, and hyphens (-) are allowed.
app_id	String	Parameter description: resource space ID. Value: The value can contain a maximum of 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.
package_type	String	Parameter description: type of the upgrade package. Options: For a software package, set this parameter to softwarePackage. For a firmware package, set this parameter to firmwarePackage.
product_id	String	Parameter description: unique ID of the product associated with the device. The value is allocated by the platform after the product is created. For details, see Creating a Product. Value: The value can contain a maximum of 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.
version	String	Parameter description: version number of the upgrade package. Value: The value can contain a maximum of 256 characters. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.
support_source_versions	Array of strings	Parameter description: list of source versions that support the upgrade of this version package. Up to 20 source versions are supported. Value: A source version number can contain only letters, digits, underscores (_), hyphens (-), and periods (.).
description	String	Parameter description: description of the upgrade package functions. Value length: a maximum of 1,024 characters
custom_info	String	Parameter description: custom information pushed to the device. After the upgrade package is added and an upgrade task is created, the IoT platform delivers the custom information to the device when delivering an upgrade notification to the device. Value length: a maximum of 4,096 characters
create_time	String	Time when the software/firmware package is uploaded to the IoT platform. The parameter value is in the format of yyyyMMdd'T'HHmmss'Z'.

**Table 6** PageInfo
Parameter	Type	Description
count	Long	Total number of records that meet the query conditions.
marker	String	ID of the last record in this query, which can be used in the next query.

Example Requests

Queries OTA upgrade packages in a list.

GET https://{endpoint}/v5/iot/{project_id}/ota-upgrades/packages

Example Responses

Status code: 200

{
  "packages" : [ {
    "package_id" : "28f61af50fc9452aa0ed5ea25c3cc3d3",
    "app_id" : "61f7e74d036aca5be29e1ed4",
    "package_type" : "firmwarePackage",
    "product_id" : "5ba24f5ebbe8f56f5a14f605",
    "version" : "V2.0",
    "support_source_versions" : [ "V1.0", "V1.1" ],
    "description" : "package for version V1.0 and V1.1",
    "custom_info" : "Updated the XX function and fixed the XXXX issue.",
    "create_time" : "20230211T121212Z"
  } ],
  "page" : {
    "count" : 10,
    "marker" : "5c90fa7d3c4e4405e8525079"
  }
}