更新时间:2025-10-10 06:55:32下载pdf
查询指定OTA升级包的详细信息。
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | QueryOTAFirmware | 系统规定参数。取值:QueryOTAFirmware。 |
| FirmwareId | String | 是 | 167 | OTA升级包ID,升级包的唯一标识符。 |
注意:调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数。
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Code | String | iot.system.SystemException | 调用失败时,返回的错误码。更多信息,请参见错误码。 |
| ErrorMessage | String | 系统异常 | 调用失败时,返回的出错信息。 |
| FirmwareInfo | Struct | 调用成功时,返回的升级包信息。详情参见以下FirmwareInfo包含的参数。 | |
| DestVersion | String | 1.0.0 | 当前OTA升级包版本号。 |
| FirmwareDesc | String | ble firmware | OTA升级包描述信息。 |
| FirmwareId | String | 158 | OTA升级包ID,升级包的唯一标识符。 |
| FirmwareName | String | t3q5rkNm | OTA升级包名称。 |
| FirmwareSign | String | 3d04ab6462633508606e5f3daac8**** | OTA升级包文件内容的签名值。 |
| FirmwareSize | Integer | 1421 | OTA升级包文件大小,单位为字节。 |
| FirmwareUrl | String | https://oss-612ba0f1-2e08-4adb-9606-78390169****.oss-cn-hangzhou.aliyuncs.com/ota/firmware/bd65da39-cf24-4d9c-b306-6ac14ff5****.bin?Expires=1777587360&OSSAccessKeyId=cS8uRRy54Rsz****&Signature=farzC8%2FVMN4HYdEtXvdiC2OevH**** | OSS存储升级包文件的URL。 |
| ModuleName | String | WifiConfigModify | OTA升级包的模块名称。 |
| ProductKey | String | a19mzPZ**** | OTA升级包所属产品的ProductKey。 |
| ProductName | String | ble1 | OTA升级包所属产品的名称。 |
| SignMethod | String | MD5 | OTA升级包签名方式。 |
| SrcVersion | String | 1.0.0 | 待升级的OTA升级包版本号。 说明 |
| Status | Integer | 2 | OTA升级包状态。 - -1:不需要验证。 - 0:未验证。 - 1:已验证。 - 2:验证中。 - 3:验证失败。 |
| Type | Integer | 0 | OTA升级包类型。 - 0:整包升级包,您上传的升级包文件包含完整的升级包,将推送整包升级包给设备进行升级。 |
| Udi | String | {“包含重大安全更新”} | 推送给设备的自定义信息。不限制文本内容的格式,长度不超过4096个字符。 创建升级任务后,物联网平台向设备推送升级通知时,会将该自定义信息下发给设备。 |
| UtcCreate | String | 2024-11-11T11:11:11.000Z | 创建OTA升级包的时间,UTC格式。 |
| UtcModified | String | 2024-11-11T11:11:11.000Z | OTA升级包最后一次修改时的时间,UTC格式。 |
| VerifyProgress | Integer | 50 | OTA升级包的验证进度。 - 0:未验证。 - 100:已完成验证。 - 0至100之间的数值N:表示N%的设备已完成升级。升级包验证状态请根据返回参数Status判断。 |
| RequestId | String | A01829CE-75A1-4920-B775-921146A1AB79 | 物联网平台为该请求生成的唯一标识符。 |
| Success | Boolean | true | 是否调用成功。 - true:调用成功。 - false:调用失败。 |
请求示例
curl 'https://si-d6e8d******8958054.tuyacloud.com:8686/?Action=ListOTAFirmware&SignatureNonce=9e6189124f5a4716ad2de849467b****&AccessKeyId=xMr9wgwXQLhv5AUa65o0****&SignatureMethod=HMAC-SHA1&Timestamp=2024-11-19T09%3A47%3A43Z&FirmwareId=167&Signature=WJN0Ee8%2BX6pogcD3loLHIqQNEN0%3D'
正常返回示例
{
"code": "",
"firmwareInfo": {
"destVersion": "1.1111",
"firmwareDesc": "",
"firmwareId": "134",
"firmwareName": "myFirmwareName",
"firmwareSign": "1111111111",
"firmwareSize": 1152925,
"firmwareUrl": "https://oss-612ba0f1-2e08-4adb-9606-78390169****.oss-cn-hangzhou.aliyuncs.com/ota/firmware/1591148694cffeb3ade09.tar_1724814144568.gz?Expires=1732099448&OSSAccessKeyId=LTAI****************&Signature=AFe6*************************",
"moduleName": "blei",
"productKey": "k1h9drZ****",
"productName": "bletest",
"signMethod": "MD5",
"status": 0,
"type": 0,
"udi": "",
"utcCreate": "2024-09-18T09:32:00.937Z",
"utcModified": "2024-09-18T09:32:00.937Z",
"verifyProgress": 0
},
"requestId": "11413537-433a-4d72-97e3-72c2211a163e",
"success": true
}