ListOTAModuleByProduct

更新时间：2025-10-10 06:56:43下载pdf

查询产品下的OTA模块列表。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	ListOTAModuleByProduct	系统规定参数。取值：ListOTAModuleByProduct。
ProductKey	String	是	k5n4I80****	产品的ProductKey。

重要

‼️ 注意：调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数。

返回数据

名称	类型	示例值	描述
Code	String	iot.system.SystemException	调用失败时，返回的错误码。更多信息，请参见错误码。
Data	Array of OtaModuleDTO		调用成功时，返回的OTA模块列表。
AliasName	String	BLE模块	模块别名。
Desc	String	这是一个BLE模块	模块描述。
GmtCreate	String	2024-11-11T07:36Z	模块创建时间，GMT格式。
GmtModified	String	2024-11-11T07:36Z	模块信息最后一次更新时间，GMT格式。
ModuleName	String	ble	模块名称。
ProductKey	String	k4in4Ke****	产品的ProductKey。
ErrorMessage	String	系统异常	调用失败时，返回的出错信息。
RequestId	String	74C2BB8D-1D6F-41F5-AE68-6B2310883F63	物联网平台为该请求生成的唯一标识符。
Success	Boolean	true	是否调用成功。 - true：调用成功。 - false：调用失败。

示例

请求示例

curl 'https://si-d6e8******8958054.tuyacloud.com:8686/?Action=ListOTAModuleByProduct&SignatureNonce=9e6189124f5a4716ad2de849467b****&AccessKeyId=xMr9wgwXQLhv5AUa65o0****&SignatureMethod=HMAC-SHA1&Timestamp=2024-11-19T09%3A47%3A43Z&ProductKey=a1uctKe****&Signature=WJN0Ee8%2BX6pogcD3loLHIqQNEN0%3D'

正常返回示例

{
    "code": "",
    "data": {
          "desc": "BLE模块",
          "gmtCreate": "2024-11-11T07:36Z",
          "moduleName": "ble",
          "aliasName": "BLE模块",
          "gmtModified": "2024-11-11T07:36Z",
          "productKey": "k4in4Ke****"
    }
    "requestId": "d2fce065-8238-4ee2-a793-0226f69b0542",
    "success": true
}

上一篇DeleteOTAModule

下一篇CreateOTAVerifyJob