Creates an over-the-air (OTA) module for a product.
Limits
OTA modules are the updatable units of the devices that belong to the same product. The default module indicates the firmware of an entire device. You can call this operation to create a custom OTA module.
- You can create a maximum of 10 custom OTA modules for each product.
- After an OTA module is created, you cannot modify its name. You can call the UpdateOTAModule operation to modify the module alias and description.
-
Each Alibaba Cloud account can run a maximum of 10 queries per second (QPS).Note RAM users of an Alibaba Cloud account share the quota of the account.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | CreateOTAModule |
The operation that you want to perform. Set the value to CreateOTAModule. |
ModuleName | String | Yes | barcodeScanner |
The name of the OTA module. The name is unique in a product and cannot be modified. The name can contain letters, digits, periods (.), hyphens (-), and underscores (_). The name must be 1 to 64 characters in length. Note Letters are not case-sensitive. For example, you cannot use the module names scanner
and Scanner at the same time.
|
ProductKey | String | Yes | a1Le6d0**** |
The ProductKey of the product to which the OTA module belongs. |
AliasName | String | No | Barcode_scanner |
The alias of the OTA module. The alias must be 1 to 64 characters in length, and can contain letters, digits, periods(.), hyphens (-), and underscores (_). |
IotInstanceId | String | No | iot-cn-0pp1n8t**** |
The ID of the instance. This parameter is not required for the public instance but required for Enterprise Edition instances. |
Desc | String | No | The firmware module of the barcode scanner. |
The description of the OTA module. The description can be up to 100 characters in length. |
In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this operation. For more information about common request parameters, see Common parameters.
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Code | String | iot.system.SystemException |
The error code returned if the call fails. For more information, see Error codes. |
ErrorMessage | String | A system exception occurred. |
The error message returned if the call fails. |
RequestId | String | 74C2BB8D-1D6F-41F5-AE68-6B2310883F63 |
The ID of the request. |
Success | Boolean | true |
Indicates whether the call was successful.
|
Examples
Sample requests
https://iot.cn-shanghai.aliyuncs.com/?Action=CreateOTAModule
&ModuleName=barcodeScanner
&ProductKey=a1Le6d0****
&<Common request parameters>
Sample success responses
XML
format
<CreateOTAModuleResponse>
<RequestId>29EC7245-0FA4-4BB6-B4F5-5F04818FDFB1</RequestId>
<Success>true</Success>
</CreateOTAModuleResponse>
JSON
format
{
"RequestId": "9F41D14E-CB5F-4CCE-939C-057F39E688F5",
"Success": true
}
Error codes
For a list of error codes, visit the API Error Center.