DISCLAIMER
Please note that all content presented on this page is provided by Tuya (HK) Limited. Alibaba Cloud makes no representations and warranties, explicit or implied, as to the authenticity or accuracy of any such content, nor makes any guarantee to the condition, quality, durability, performance, reliability, merchantability or fitness for a particular purpose, or non-infringement of any products and/or services made available by Tuya (HK) Limited.
Create the OTA module for the product.
Instructions for use
OTA modules are different upgradeable modules for devices under the same product. The default module represents the OTA upgrade package for the entire device.
Customize a maximum of 10 OTA modules under the same product.
The OTA module name cannot be changed after creation
Request Parameters
Name | Type | Required | Sample Values | Description |
Action | String | Yes | CreateOTAModule | System defined parameters. Value: CreateOTAModule. |
ModuleName | String | Yes | Ble | The name of the OTA module, which is unique under the product and cannot be modified. Only English letters, numbers, periods (.), dashes (-), and underscores (_) are supported. The length is limited to 1 to 64 characters. |
ProductKey | String | Yes | K5n4I80 * * * * | The ProductKey of the product to which the OTA module belongs. |
AliasName | String | No | BLE | OTA module alias. Supports Chinese, English letters, digits, periods (.), dashes (-), and underscores (_). The length is limited to 1 to 64 characters. |
Desc | String | No | BLE module | The description of the OTA module. It can be up to 100 characters long. |
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.
Return Data
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. |
Example
Request Example
curl 'https://si-d6e8d812acb848958054.tuyacloud.com:8686/?Action=CreateOTAModule&SignatureNonce=9e6189124f5a4716ad2de849467b****&AccessKeyId=xMr9wgwXQLhv5AUa65o0****&SignatureMethod=HMAC-SHA1&Timestamp=2024-11-19T09%3A47%3A43Z&ProductKey=a1uctKe****&ModuleName=ble&Signature=WJN0Ee8%2BX6pogcD3loLHIqQNEN0%3D'Normal Return Example
{
"code": "",
"requestId": "d2fce065-8238-4ee2-a793-0226f69b0542",
"success": true
}