調用該介面批量修改裝置備忘名稱。
QPS限制
單個阿里雲帳號調用該介面的每秒請求數(QPS)最大限制為10。
說明 RAM使用者共用阿里雲帳號配額。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
請求參數
| 名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
| Action | String | 是 | BatchUpdateDeviceNickname | 系統規定參數。取值:BatchUpdateDeviceNickname。 |
| IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** | 執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面,查看當前執行個體的ID。 重要
執行個體的更多資訊,請參見執行個體概述。 |
| DeviceNicknameInfo.N.ProductKey | String | 否 | a1BwAGV**** | 要修改備忘名稱的裝置所隸屬的產品ProductKey。 說明 如果傳入該參數,需同時傳入DeviceName。 |
| DeviceNicknameInfo.N.DeviceName | String | 否 | light | 要修改備忘名稱的裝置名稱。 說明 如果傳入該參數,需同時傳入ProductKey。 |
| DeviceNicknameInfo.N.Nickname | String | 否 | AliyunDataCenter | 新的裝置備忘名稱。備忘名稱長度為4~32個字元,可包含中文漢字、英文字母、數字和底線(_)。一個中文漢字算2個字元。 說明 若不傳入該參數,則刪除該裝置原有的備忘名稱。 |
| DeviceNicknameInfo.N.IotId | String | 否 | Q7uOhVRdZRRlDnTLv****00100 | 要修改備忘名稱的裝置ID。 說明 如果傳入該參數,則無需傳入ProductKey和DeviceName。IotId作為裝置唯一識別碼,和ProductKey與DeviceName組合是一一對應的關係。如果您同時傳入IotId和ProductKey與DeviceName組合,則以IotId為準。 |
調用API時,除了本文介紹的該API的特有請求參數,還需傳入公用請求參數。公用請求參數說明,請參見公用參數文檔。
返回資料
| 名稱 | 類型 | 樣本值 | 描述 |
| Code | String | iot.system.SystemException | 調用失敗時,返回的錯誤碼。更多資訊,請參見錯誤碼。 |
| ErrorMessage | String | 系統異常 | 調用失敗時,返回的出錯資訊。 |
| RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | 阿里雲為該請求產生的唯一識別碼。 |
| Success | Boolean | true | 表示是否調用成功。
|
樣本
請求樣本
https://iot.cn-shanghai.aliyuncs.com/?Action=BatchUpdateDeviceNickname
&DeviceNicknameInfo.1.ProductKey=a1rYuVF****
&DeviceNicknameInfo.1.DeviceName=SR8FiTu1R9tlUR2V1bmi
&DeviceNicknameInfo.1.Nickname=airconditioning_type1
&DeviceNicknameInfo.2.ProductKey=a1yrZMH****
&DeviceNicknameInfo.2.DeviceName=RkQ8CFtNpDok4BEunymt
&DeviceNicknameInfo.2.Nickname=airconditioning_type2
&<公用請求參數>
正常返回樣本
XML格式
<BatchUpdateDeviceNicknameResponse>
<RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
<Success>true</Success>
</BatchUpdateDeviceNicknameResponse>
JSON格式
{
"RequestId":"57b144cf-09fc-4916-a272-a62902d5b207",
"Success": true
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。