調用該介面修改OTA模組別名、描述。
QPS限制
單個阿里雲帳號調用該介面的每秒請求數(QPS)最大限制為10。
說明 RAM使用者共用阿里雲帳號配額。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
請求參數
| 名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
| Action | String | 是 | UpdateOTAModule | 系統規定參數。取值:UpdateOTAModule。 |
| ModuleName | String | 是 | barcodeScanner | OTA模組名稱。 |
| ProductKey | String | 是 | a1Le6d0**** | OTA模組所屬產品的ProductKey。 |
| AliasName | String | 否 | 條碼掃描器2 | 新的模組別名。支援中文、英文字母、數字、英文句號(.)、短劃線(-)和底線(_),長度限制為1~64個字元。 |
| IotInstanceId | String | 否 | iot-cn-0pp1n8t**** | 執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面,查看當前執行個體的ID。 重要
執行個體的更多資訊,請參見執行個體概述。 |
| Desc | String | 否 | 條碼掃描器的韌體模組 | 新的模組描述資訊,支援最多100個字元。 |
調用API時,除了本文介紹的該API的特有請求參數,還需傳入公用請求參數。公用請求參數說明,請參見公用參數文檔。
返回資料
| 名稱 | 類型 | 樣本值 | 描述 |
| Code | String | iot.system.SystemException | 調用失敗時,返回的錯誤碼。更多資訊,請參見錯誤碼。 |
| ErrorMessage | String | 系統異常 | 調用失敗時,返回的出錯資訊。 |
| RequestId | String | 74C2BB8D-1D6F-41F5-AE68-6B2310883F63 | 阿里雲為該請求產生的唯一識別碼。 |
| Success | Boolean | true | 是否調用成功。
|
樣本
請求樣本
https://iot.cn-shanghai.aliyuncs.com/?Action=UpdateOTAModule
&ModuleName=barcodeScanner
&ProductKey=a1Le6d0****
&AliasName=條碼掃描器2
&<公用請求參數>
正常返回樣本
XML格式
<UpdateOTAModuleResponse>
<RequestId>29EC7245-0FA4-4BB6-B4F5-5F04818FDFB1</RequestId>
<Success>true</Success>
</UpdateOTAModuleResponse>
JSON格式
{
"RequestId": "9F41D14E-CB5F-4CCE-939C-057F39E688F5",
"Success": true
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。