更新时间:2025-10-10 07:00:27下载pdf
查询设备上报过的OTA模块版本列表。
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListOTAModuleVersionsByDevice | 系统规定参数。取值:ListOTAModuleVersionsByDevice。 |
| CurrentPage | Integer | 是 | 1 | 指定从返回结果中的第几页开始显示。默认值是1。 |
| PageSize | Integer | 是 | 10 | 指定返回结果中每页显示的模块版本数量。数量限制:每页最多可显示200条。 |
| ProductKey | String | 否 | k1nhvyl**** | 要查询设备所属的产品ProductKey。 |
| DeviceName | String | 否 | device1 | 指定要查询设备的名称。 |
| IotId | String | 否 | ca460d9993c9d1eae0adba**** | 物联网平台为该设备颁发的ID,设备的唯一标识符。 |
注意:调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数。
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Code | String | iot.system.SystemException | 调用失败时,返回的错误码。更多信息,请参见错误码。 |
| CurrentPage | Integer | 1 | 当前页面号。 |
| Data | Array of SimpleOTAModuleInfo | 调用成功时,返回的设备上报的模块版本信息。更多信息,请参见以下SimpleOTAModuleInfo信息。 | |
| SimpleOTAModuleInfo | |||
| DeviceName | String | device1 | 设备名称。 |
| IotId | String | ca460d999273ca35aea2ectonv**** | 设备ID。 |
| ModuleName | String | ble | 模块名称。 |
| ModuleVersion | String | 1.0.0 | 设备上报的模块版本。 |
| ProductKey | String | k1nhvyl**** | 设备所属产品的ProductKey。 |
| ErrorMessage | String | 系统异常 | 调用失败时,返回的出错信息。 |
| PageCount | Integer | 1 | 返回的总页数。 |
| PageSize | Integer | 10 | 每页显示的模块版本数量。 |
| RequestId | String | 291438BA-6E10-4C4C-B761-243B9A0D324F | 物联网平台为该请求生成的唯一标识符。 |
| Success | Boolean | true | 表示是否调用成功。 - true:调用成功。 - false:调用失败。 |
| Total | Integer | 10 | 设备上报的模块版本总数。 |
请求示例
curl 'https://si-d6e8******8958054.tuyacloud.com:8686/?Action=ListOTAModuleVersionsByDevice&SignatureNonce=9e6189124f5a4716ad2de849467b****&AccessKeyId=xMr9wgwXQLhv5AUa65o0****&SignatureMethod=HMAC-SHA1&Timestamp=2024-11-19T09%3A47%3A43Z&CurrentPage=1&PageSize=10&Signature=WJN0Ee8%2BX6pogcD3loLHIqQNEN0%3D'
正常返回示例
{
"code": "",
"currentPage": 1,
"data": {
"simpleOTAModuleInfo": [
{
"deviceName": "device001",
"iotId": "OZs5tjTkzRRTZSCekmbRk1****",
"moduleName": "ble",
"moduleVersion": "1.0",
"productKey": "k1h9drZble"
}
]
},
"pageCount": 1,
"pageSize": 10,
"requestId": "47f85a55-2ffb-40d4-9d0a-efd41fac7380",
"success": true,
"total": 1
}