Updates the OTA upgrade package of a device, including the upgrade package name, upgrade package description, and custom information.
| Name | Type | Required | Sample Values | Description |
|---|---|---|---|---|
| Action | String | Yes | ModifyOTAFirmware | System defined parameters. Value: ModifyOTAFirmware. |
| FirmwareId | String | Yes | 127 | The ID of the OTA upgrade package. |
| FirmwareName | String | Yes | Firmware2 | The name of the OTA upgrade package, which cannot be modified after creation. Chinese, English, Japanese, numbers, dashes (-), underscores (_), and half-angle parentheses () are supported. They must start with Chinese, English, Japanese, or a number. The length is limited to 1 to 40 characters. |
| ProductKey | String | No | A1uctKe * * * * | Of the product to which the OTA upgrade package belongs ProductKey . |
| FirmwareDesc | String | No | Ota function updated | Ota upgrade package description. The length cannot exceed 100 characters. A Chinese character counts as one character. |
| Udi | String | No | {"Ota_notice":"Upgrade the underlying camera driver to solve the problem of blurred video images. "} | Custom information pushed to the device. The text content format is unlimited, and the length cannot exceed 4096 characters. After the upgrade package is added and an upgrade task is created, IoT Platform sends the custom information to the device when it pushes an upgrade notification to the device. |
Note: When calling an API, in addition to the API-specific request parameters described in this topic, you must also pass in the common request parameters. For more information about common request parameters, see Common parameters.
| Name | Type | Sample Values | Description |
|---|---|---|---|
| Code | String | Iot.system.SystemException | The error code returned when the call fails. For more information, see Error codes. |
| ErrorMessage | String | System Exception | Error information returned when the call fails. |
| RequestID | String | Kan | The unique identifier that IoT Platform generates for the request. |
| Success | Boolean | True | Whether the call was successful. ●True : The call is successful, indicating that the OTA upgrade package is successfully created. ●False : The call fails, indicating that the OTA upgrade package failed to be created. |
Request Example
curl 'https://si-d6e******48958054.tuyacloud.com:8686/?Action=ModifyOTAFirmware&SignatureNonce=9e6189124f5a4716ad2de849467b****&AccessKeyId=xMr9wgwXQLhv5AUa65o0****&SignatureMethod=HMAC-SHA1&Timestamp=2024-11-19T09%3A47%3A43Z&ProductKey=a1uctKe****&FirmwareName=Firmware2&DestVersion=1.9.9&FirmwareId=165&FirmwareDesc=modifyfirmware&Signature=WJN0Ee8%2BX6pogcD3loLHIqQNEN0%3D'
Normal Return Example
{
"code": "",
"requestId": "d2fce065-8238-4ee2-a793-0226f69b0542",
"success": true
}