ListOTAFirmware - Developer Guide (Cloud)| Alibaba Cloud Documentation Center

Limits

A single Alibaba Cloud account can run a maximum of 10 queries per second (QPS). RAM users share the quota of the Alibaba Cloud account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	ListOTAFirmware	The operation that you want to perform. Set the value to ListOTAFirmware.
CurrentPage	Integer	Yes	1	The number of the page to return. Pages start from page 1.
PageSize	Integer	Yes	10	The number of entries to return on each page. Maximum value: 100.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	The ID of the instance. This parameter is not required for public instances. However, the parameter is required for the instances that you have purchased.
ProductKey	String	No	a19mzPZ****	The key of the product to which the firmware belongs. If you specify this parameter, the system returns the firmware list of the specified product. If you do not specify this parameter, the system returns the firmware list of the current Alibaba cloud account.
DestVersion	String	No	4.0.0	The version of the firmware. If you specify this parameter, only the firmware of the specified version is returned.

In addition to the preceding exclusive request parameters, you must specify common request parameters when calling this API operation. For more information about common request parameters, see Common parameters.

Response parameters


Element	Type	Example	Description
Code	String	iot.system.SystemException	The error code returned if the call failed. For more information about error codes, see Error codes.
CurrentPage	Integer	1	The page number of the returned page.
ErrorMessage	String	A system exception occurred.	The error message returned if the call failed.
FirmwareInfo	Array		The firmware list returned if the call was successful. For more information, see the following parameters in SimpleFirmwareInfo.
SimpleFirmwareInfo
DestVersion	String	4bOYEnic	The current version of the firmware.
FirmwareDesc	String	firmwareDesc	The description of the firmware.
FirmwareId	String	UfuxnwygsuSkVE0VCN****0100	The ID of the firmware.
FirmwareName	String	t3q5rkNm	The name of the product to which the firmware belongs.
FirmwareSign	String	3d04ab6462633508606e5f3daac8****	The signature value of the firmware.
FirmwareSize	Integer	924	The size of the firmware. Unit: bytes.
FirmwareUrl	String	https://iotx-ota-pre.oss-cn-shanghai.aliyuncs.com/ota/572ef2fd12ca4791a5b21a9eb948**/5E962CF83DB1495E8337E9C8A4D1**.bin	The URL of the firmware. The URL indicates the storage location of the firmware file in OSS.
ModuleName	String	module1234	The name of the firmware module to be updated.
ProductKey	String	a19mzPZ****	The key of the product to which the firmware belongs.
ProductName	String	MyProduct	The name of the product to which the firmware belongs.
SignMethod	String	MD5	The signature method of the firmware.
SrcVersion	String	V1.0.0	The version of the firmware to be updated. Note This parameter is only returned when you perform a delta update.
Status	Integer	0	The status of the firmware. Valid values: 0:unverified 1:verified 2: being verified 3: failed to be verified
Type	Integer	0	The type of the firmware update. Valid values: 0: full update 1: delta update
UtcCreate	String	2019-12-28T02:42:22.000Z	The time when the firmware was created. The time is in UTC.
UtcModified	String	2019-12-28T02:42:22.000Z	The time when the firmware was last modified. The time is in UTC.
PageCount	Integer	1	The total number of pages returned.
PageSize	Integer	10	The number of entries returned per page.
RequestId	String	A01829CE-75A1-4920-B775-921146A1AB79	The globally unique ID generated by Alibaba Cloud for the request.
Success	Boolean	true	Indicates whether the call was successful. true indicates that the call was successful. false indicates that the call failed.
Total	Integer	1	The total number of firmware files.

Samples

Sample requests

https://iot.cn-shanghai.aliyuncs.com/?Action= ListOTAFirmware
&CurrentPage=1
&PageSize=10
&ProductKey=a19mzPZ****
&DestVersion=4.0.0
&<Common request parameters>

Sample success responses

XML format

<ListOTAFirmwareResponse>
  <PageCount>1</PageCount>
  <PageSize>10</PageSize>
  <RequestId>A01829CE-75A1-4920-B775-921146A1AB79</RequestId>
  <FirmwareInfo>
        <SimpleFirmwareInfo>
              <SrcVersion>1.0.0</SrcVersion>
              <FirmwareSign>3d04ab6462633508606e5f3daac8****</FirmwareSign>
              <ProductKey>a19mzPZ****</ProductKey>
              <Type>0</Type>
              <UtcModified>2019-12-28T02:42:22.000Z</UtcModified>
              <SignMethod>MD5</SignMethod>
              <UtcCreate>2019-12-28T02:42:22.000Z</UtcCreate>
              <FirmwareSize>924</FirmwareSize>
              <Status>0</Status>
              <FirmwareId>UfuxnwygsuSkVE0VCN****0100</FirmwareId>
              <FirmwareDesc>firmwareDesc</FirmwareDesc>
              <FirmwareUrl>https://iotx-ota-pre.oss-cn-shanghai.aliyuncs.com/ota/572ef2fd12ca4791a5b21a9eb948****/5E962CF83DB1495E8337E9C8A4D1****.bin</FirmwareUrl>
              <DestVersion>4.0.0</DestVersion>
              <ProductName>MyProduct</ProductName>
              <FirmwareName>t3q5rkNm</FirmwareName>
              <ModuleName>module1234</ModuleName>
        </SimpleFirmwareInfo>
  </FirmwareInfo>
  <CurrentPage>1</CurrentPage>
  <Success>true</Success>
  <Total>1</Total>
</ListOTAFirmwareResponse>

JSON format

{
  "PageCount": 1,
  "PageSize": 10,
  "RequestId": "A01829CE-75A1-4920-B775-921146A1AB79",
  "FirmwareInfo": {
    "SimpleFirmwareInfo": [{
      "SrcVersion": "1.0.0",
      "FirmwareSign": "3d04ab6462633508606e5f3daac8****",
      "ProductKey": "a19mzPZ****",
      "Type": 0,
      "UtcModified": "2019-12-28T02:42:22.000Z",
      "SignMethod": "MD5",
      "UtcCreate": "2019-12-28T02:42:22.000Z",
      "FirmwareSize": 924,
      "Status": 0,
      "FirmwareId": "UfuxnwygsuSkVE0VCN****0100",
      "FirmwareDesc": "firmwareDesc",
      "FirmwareUrl": "https://iotx-ota-pre.oss-cn-shanghai.aliyuncs.com/ota/572ef2fd12ca4791a5b21a9eb948****/5E962CF83DB1495E8337E9C8A4D1****.bin",
      "DestVersion": "4.0.0",
      "ProductName": "MyProduct",
      "FirmwareName": "t3q5rkNm",
      "ModuleName": "module1234"
    }]
  },
  "CurrentPage": 1,
  "Success": true,
  "Total": 1
}

Error codes

For a list of error codes, visit the API Error Center.