調用該接口批量修改設備備注名稱。

QPS限制

單個阿里云賬號調用該接口的每秒請求數(QPS)最大限制為10。

說明 RAM用戶共享阿里云賬號配額。

調試

您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String BatchUpdateDeviceNickname

系統規定參數。取值:BatchUpdateDeviceNickname。

IotInstanceId String iot_instc_pu****_c*-v64********

實例ID。您可在物聯網平臺控制臺的實例概覽頁面,查看當前實例的ID

注意
  • 若有ID值,必須傳入該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。

說明 如果傳入該參數,則無需傳入ProductKeyDeviceNameIotId作為設備唯一標識符,和ProductKeyDeviceName組合是一一對應的關系。如果您同時傳入IotIdProductKeyDeviceName組合,則以IotId為準。

調用API時,除了本文介紹的該API的特有請求參數,還需傳入公共請求參數。公共請求參數說明,請參見公共參數文檔

返回數據

名稱 類型 示例值 描述
Code String iot.system.SystemException

調用失敗時,返回的錯誤碼。更多信息,請參見錯誤碼

ErrorMessage String 系統異常

調用失敗時,返回的出錯信息。

RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

阿里云為該請求生成的唯一標識符。

Success Boolean true

表示是否調用成功。

  • true:調用成功。
  • false:調用失敗。

示例

請求示例

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
}