Queries the version information of the over-the-air (OTA) modules that are submitted by a device.

Limits

Each Alibaba Cloud account can run a maximum of 10 queries per second (QPS).

Note RAM users of an Alibaba Cloud account share the quota of the account.

Debugging

Alibaba Cloud provides OpenAPI Explorer to simplify API usage. 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 ListOTAModuleVersionsByDevice

The operation that you want to perform. Set the value to ListOTAModuleVersionsByDevice.

CurrentPage Integer Yes 1

The number of the page to return. Default value: 1.

PageSize Integer Yes 10

The number of entries to return on each page. A maximum of 200 entries can be displayed on each page.

IotInstanceId String No iot_instc_pu****_c*-v64********

The ID of the instance. You can view the instance ID on the Overview page in the IoT Platform console.

Notice
  • If your instance has an ID, you must configure this parameter. If you do not set this parameter, the call fails.
  • If your instance has no Overview page or ID, you do not need to set this parameter.

For more information, see Overview.

ProductKey String No aluctKe****

The ProductKey of the product to which the device belongs.

Note If you specify this parameter, you must also specify the DeviceName parameter.
DeviceName String No newdevice

The DeviceName of the device to be queried.

Note If you specify this parameter, you must also specify the ProductKey parameter.
IotId String No Q7uOhVRdZRRlDnTLv****00100

The ID of the device. The device ID is issued by IoT Platform.

Note If you specify this parameter, you do not need to specify ProductKey or DeviceName. The IotId parameter specifies a globally unique identifier (GUID) of the device, which corresponds to a combination of ProductKey and DeviceName. If you specify both IotId and the combination of ProductKey and DeviceName, IotId takes precedence.

In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this operation. For more information, see Common request parameters.

Response parameters

Parameter Type Example Description
Code String iot.system.SystemException

The error code returned if the call fails. For more information, see Error codes.

CurrentPage Integer 1

The current page number.

Data Array of SimpleOTAModuleInfo

The module version information returned if the call is successful. The information was submitted by the device. For more information, see the SimpleOTAModuleInfo parameter in this table.

SimpleOTAModuleInfo
DeviceName String newDevice

The DeviceName of the device.

IotId String QjIFT***000101

The ID of the device.

ModuleName String barcodeScanner

The name of the OTA module.

ModuleVersion String 1.0

The module version that was submitted by the device.

ProductKey String aluctKe****

The ProductKey of the product to which the device belongs.

ErrorMessage String A system exception occurred.

The error message returned if the call fails.

PageCount Integer 1

The total number of pages returned.

PageSize Integer 10

The number of module versions returned on each page.

RequestId String 291438BA-6E10-4C4C-B761-243B9A0D324F

The ID of the request.

Success Boolean true

Indicates whether the call was successful.

  • true: The call was successful.
  • false: The call failed.
Total Integer 10

The total number of module versions that was submitted by the device.

Examples

Sample requests

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListOTAModuleVersionsByDevice
&CurrentPage=1
&PageSize=10
&<Common request parameters>

Sample success responses

XML format 

<ListOTAModuleVersionsByDeviceResponse>
  <requestId>67AF7881-704C-40CC-B296-72F91380A117</requestId>
  <success>true</success>
  <code></code>
  <errorMessage></errorMessage>
  <PageSize>10</PageSize>
  <PageCount>1</PageCount>
  <CurrentPage>1</CurrentPage>
  <Total>1</Total>
  <Data>
        <SimpleOTAModuleInfo>
              <IotId>QjIFT***000101</IotId>
              <ModuleVersion>1.6940.1</ModuleVersion>
              <ModuleName>default</ModuleName>
              <ProductKey>a14***S</ProductKey>
              <DeviceName>newDevice</DeviceName>
        </SimpleOTAModuleInfo>
  </Data>
</ListOTAModuleVersionsByDeviceResponse>

JSON format 

{
    "requestId": "67AF7881-704C-40CC-B296-72F91380A117",
    "success": true,
    "code": "",
    "errorMessage": null,
    "PageSize": 10,
    "PageCount": 1,
    "CurrentPage": 1,
    "Total": 1,
    "Data": {
        "SimpleOTAModuleInfo": [
            {
                "IotId": "QjIFT***000101",
                "ModuleVersion": "1.6940.1",
                "ModuleName": "default",
                "ProductKey": "a14***S",
                "DeviceName": "newDevice"
            }
        ]
    }
}

Error codes

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