CreateOTAFirmware
CreateOTAFirmware
创建设备的OTA升级包。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
Action | String | 是 | CreateOTAFirmware | 系统规定参数。取值：CreateOTAFirmware。 |
DestVersion | String | 是 | 2.0.0 | 当前OTA升级包的版本号，仅支持英文字母、数字、半角句号（.）、短划线（-）和下划线（_）。长度限制为1~64个字符。 |
FirmwareName | String | 是 | Firmware2 | OTA升级包名称，创建后不可修改。支持中文、英文字母、日文、数字、短划线（-）、下划线（_）和半角圆括号（()），必须以中文、英文、日文或数字开头，长度限制为1~40个字符。 |
FirmwareUrl | String | 否 | https://oss-612ba0f1-2e08-4adb-9606-78390169****.oss-cn-hangzhou.aliyuncs.com/ota/firmware/bd65da39-cf24-4d9c-b306-6ac14ff5****.bin | OTA升级包文件的URL，即升级包文件在对象存储（OSS）上的存储地址。您可调用GenerateOTAUploadURL生成升级包文件的URL。 |
FirmwareSign | String | 否 | 93230c3bde425a9d7984a594ac55**** | OTA升级包文件的签名值。使用SignMethod值（SHA256或MD5）对升级包文件内容加签计算得出的值。 |
SignMethod | String | 否 | MD5 | OTA升级包签名方法。取值：
|
FirmwareSize | Integer | 否 | 900 | OTA升级包文件的大小，单位：字节。 |
ProductKey | String | 否 | a1uctKe**** | OTA升级包所属产品的ProductKey。 |
FirmwareDesc | String | 否 | OTA function updated | OTA升级包描述。长度不可超过100个字符。一个中文汉字算一个字符。 |
Type | Integer | 否 | 0 | OTA升级包类型。
后续将支持差分包升级 |
SrcVersion | String | 否 | 1.0.0 | 待升级OTA模块版本号，即待升级设备的当前OTA模块版本号。 |
ModuleName | String | 否 | WifiConfigModify | OTA模块名称。OTA模块是同产品下设备的不同可升级模块。 |
NeedToVerify | Boolean | 否 | true | 是否需要在创建批量升级任务前通过升级包验证。
|
Udi | String | 否 | {"ota_notice":"升级底层摄像头驱动，解决视频图像模糊的问题。"} | 推送给设备的自定义信息。不限制文本内容格式，长度不超过4096个字符。 添加该升级包完成，并创建升级任务后，物联网平台向设备推送升级通知时，会将该自定义信息下发给设备。 |
‼️ 注意：调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数。
返回数据
名称 | 类型 | 示例值 | 描述 |
Code | String | iot.system.SystemException | 调用失败时，返回的错误码。更多信息，请参见错误码。 |
Data | Struct | 调用成功时，返回的升级包信息。更多信息，请参见Data下参数描述。 | |
FirmwareId | String | s8SSHiKjpBfrM3BSN0z803**** | OTA升级包ID，物联网平台为升级包颁发的唯一标识符。 |
UtcCreate | String | 2024-11-11T11:21:54.607Z | OTA升级包的创建时间，UTC格式。 |
ErrorMessage | String | 系统异常 | 调用失败时，返回的出错信息。 |
RequestId | String | 291438BA-6E10-4C4C-B761-243B9A0D324F | 物联网平台为该请求生成的唯一标识符。 |
Success | Boolean | true | 是否调用成功。
|
示例
请求示例
curl 'https://si-d6e8d812acb848958054.tuyacloud.com:8686/?Action=CreateOTAFirmware&SignatureNonce=9e6189124f5a4716ad2de849467b****&AccessKeyId=xMr9wgwXQLhv5AUa65o0****&SignatureMethod=HMAC-SHA1&Timestamp=2024-11-19T09%3A47%3A43Z&ProductKey=a1uctKe****&FirmwareName=Firmware2&DestVersion=1.9.9&FirmwareUrl=https%3A%2F%2Foss-612ba0f1-2e08-4adb-9606-78390169%2A%2A%2A%2A.oss-cn-hangzhou.aliyuncs.com%2Fota%2Ffirmware%2Fbd65da39-cf24-4d9c-b306-6ac14ff5%2A%2A%2A%2A.bin&SignMethod=MD5&FirmwareSign=93230c3bde425a9d7984a594ac55****&FirmwareSize=900&FirmwareDesc=createfirmware&Type=0&ModuleName=ble&Signature=WJN0Ee8%2BX6pogcD3loLHIqQNEN0%3D'正常返回示例
{
"code": "",
"data": {
"firmwareId": "143",
"utcCreate": "2024-11-20T08:50:00.239Z"
},
"requestId": "d2fce065-8238-4ee2-a793-0226f69b0542",
"success": true
}