Modifies the alias and description of an OTA module.
Limits
Each Alibaba Cloud account can run a maximum of 10 queries per second (QPS).
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | UpdateOTAModule |
The operation that you want to perform. Set the value to UpdateOTAModule. |
ModuleName | String | Yes | barcodeScanner |
The name of the OTA module. |
ProductKey | String | Yes | a1Le6d0**** |
The ProductKey of the product to which the OTA module belongs. |
AliasName | String | No | Barcode_scanner_2 |
The new 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. You can view the instance ID on the Overview page in the IoT Platform console. Notice
For more information, see Overview. |
Desc | String | No | The firmware module of the barcode scanner. |
The new 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, see Common request 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=UpdateOTAModule
&ModuleName=barcodeScanner
&ProductKey=a1Le6d0****
&AliasName=Barcode_scanner_2
&<Common request parameters>
Sample success responses
XML
format
<UpdateOTAModuleResponse>
<RequestId>29EC7245-0FA4-4BB6-B4F5-5F04818FDFB1</RequestId>
<Success>true</Success>
</UpdateOTAModuleResponse>
JSON
format
{
"RequestId": "9F41D14E-CB5F-4CCE-939C-057F39E688F5",
"Success": true
}
Error codes
For a list of error codes, visit the API Error Center.