調(diào)用該接口查詢?cè)O(shè)備上報(bào)過(guò)的OTA模塊版本列表。

QPS限制

單個(gè)阿里云賬號(hào)調(diào)用該接口的每秒請(qǐng)求數(shù)（QPS）最大限制為10。

說(shuō)明 RAM用戶共享阿里云賬號(hào)配額。

調(diào)試

您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。

請(qǐng)求參數(shù)

名稱 類型 是否必選 示例值 描述
Action String 是 ListOTAModuleVersionsByDevice

系統(tǒng)規(guī)定參數(shù)。取值：ListOTAModuleVersionsByDevice。
CurrentPage Integer 是 1

指定從返回結(jié)果中的第幾頁(yè)開(kāi)始顯示。默認(rèn)值是1。
PageSize Integer 是 10

指定返回結(jié)果中每頁(yè)顯示的模塊版本數(shù)量。數(shù)量限制：每頁(yè)最多可顯示200條。
IotInstanceId String 否 iot_instc_pu****_c*-v64********

實(shí)例ID。您可在物聯(lián)網(wǎng)平臺(tái)控制臺(tái)的實(shí)例概覽頁(yè)面，查看當(dāng)前實(shí)例的ID。

注意
  • 若有ID值，必須傳入該ID值，否則調(diào)用會(huì)失敗。
  • 若無(wú)ID值，則無(wú)需傳入。

實(shí)例的更多信息，請(qǐng)參見(jiàn)實(shí)例概述。

ProductKey String 否 aluctKe****

要查詢?cè)O(shè)備所屬的產(chǎn)品ProductKey。

說(shuō)明 如果傳入該參數(shù)，需同時(shí)傳入DeviceName。
DeviceName String 否 newdevice

指定要查詢?cè)O(shè)備的名稱。

說(shuō)明 如果傳入該參數(shù)，需同時(shí)傳入ProductKey。
IotId String 否 Q7uOhVRdZRRlDnTLv****00100

要查詢的設(shè)備ID。物聯(lián)網(wǎng)平臺(tái)為該設(shè)備頒發(fā)的ID，設(shè)備的唯一標(biāo)識(shí)符。

說(shuō)明 如果傳入該參數(shù)，則無(wú)需傳入ProductKey和DeviceName。IotId作為設(shè)備唯一標(biāo)識(shí)符，和ProductKey與DeviceName組合是一一對(duì)應(yīng)的關(guān)系。如果您同時(shí)傳入IotId和ProductKey與DeviceName組合，則以IotId為準(zhǔn)。

調(diào)用API時(shí)，除了本文介紹的該API的特有請(qǐng)求參數(shù)，還需傳入公共請(qǐng)求參數(shù)。公共請(qǐng)求參數(shù)說(shuō)明，請(qǐng)參見(jiàn)公共參數(shù)文檔。

返回?cái)?shù)據(jù)

名稱 類型 示例值 描述
Code String iot.system.SystemException

調(diào)用失敗時(shí)，返回的錯(cuò)誤碼。更多信息，請(qǐng)參見(jiàn)錯(cuò)誤碼。

CurrentPage Integer 1

當(dāng)前頁(yè)面號(hào)。
Data Array of SimpleOTAModuleInfo

調(diào)用成功時(shí)，返回的設(shè)備上報(bào)的模塊版本信息。更多信息，請(qǐng)參見(jiàn)以下SimpleOTAModuleInfo信息。

SimpleOTAModuleInfo
DeviceName String newDevice

設(shè)備名稱。
IotId String QjIFT***000101

設(shè)備ID。
ModuleName String barcodeScanner

模塊名稱。
ModuleVersion String 1.0

設(shè)備上報(bào)的模塊版本。
ProductKey String aluctKe****

設(shè)備所屬產(chǎn)品的ProductKey。

ErrorMessage String 系統(tǒng)異常

調(diào)用失敗時(shí)，返回的出錯(cuò)信息。
PageCount Integer 1

返回的總頁(yè)數(shù)。
PageSize Integer 10

每頁(yè)顯示的模塊版本數(shù)量。
RequestId String 291438BA-6E10-4C4C-B761-243B9A0D324F

阿里云為該請(qǐng)求生成的唯一標(biāo)識(shí)符。
Success Boolean true

表示是否調(diào)用成功。

  • true：調(diào)用成功。
  • false：調(diào)用失敗。
Total Integer 10

設(shè)備上報(bào)的模塊版本總數(shù)。

示例

請(qǐng)求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListOTAModuleVersionsByDevice
&CurrentPage=1
&PageSize=10
&<公共請(qǐng)求參數(shù)>

正常返回示例

XML格式 

<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格式 

{
    "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"
            }
        ]
    }
}