Query the OTA Module List

Function

This API is used to query the OTA module list of a specified product.

Debugging

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

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
iotda:otamodules:queryList	List	app *	g:EnterpriseProjectId	-	-

URI

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

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
app_id	Yes	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 up to 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.
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 Create a Product. Value: The value can contain up to 36 characters. Only letters, digits, underscores (_), and hyphens (-) 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.
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 must contain 24 hexadecimal characters. The default value is 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.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Instance-Id	No	String	Parameter description: instance ID. Unique identifier of each instance in the physical multi-tenant scenario. Mandatory for professional editions and recommended in other cases. Log in to the IoTDA console and choose Overview in the navigation pane to view the instance ID. For details, see Viewing Instance Details.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
modules	Array of OtaModuleInfo objects	Module list.
page	PageInfo object	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** OtaModuleInfo
Parameter	Type	Description
module_id	String	OTA module ID.
app_id	String	Resource space ID.
product_id	String	ID of the product associated with the OTA module.
product_name	String	Name of the product associated with the OTA module.
module_name	String	OTA module name.
alias_name	String	OTA module alias.
description	String	Module description.
create_time	String	Time when the OTA module is created. The format is yyyyMMdd'T'HHmmss'Z'.

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

Example Requests

This API is used to query the OTA module list.

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

Example Responses

Status code: 200

{
  "modules" : [ {
    "module_id" : "28f61af50fc9452aa0ed5ea25c3cc3d3",
    "app_id" : "61f7e74d036aca5be29e1ed4",
    "product_id" : "5ba24f5ebbe8f56f5a14f605",
    "product_name" : "Thermometer",
    "module_name" : "MCU",
    "alias_name" : "Micro Controller Unit",
    "description" : "Microcontroller unit firmware module.",
    "create_time" : "20230211T121212Z"
  } ],
  "page" : {
    "count" : 10,
    "marker" : "5c90fa7d3c4e4405e8525079"
  }
}