BatchUpdateDeviceNickname

Last Updated on : 2025-10-09 10:12:04Copy for LLMView as Markdown

Call this interface to modify device comment names in batches.

Request Parameters

Name Type Required Sample Values Description
Action String Yes BatchUpdateDeviceNickname System defined parameters. Value: BatchUpdateDeviceNickname.
DeviceNicknameInfo.N.ProductKey String No A1BwAGV * * * * The ProductKey of the product to which the device whose note name is to be modified belongs.
DeviceNicknameInfo.N.DeviceName String No Light The name of the device for which you want to modify the note name.
DeviceNicknameInfo.N.Nickname String No AliyunDataCenter New device note name. The note name can be 4 to 32 characters in length and can contain Chinese characters, English letters, numbers, and underscores (_). A Chinese character counts as 2 characters.
EviceNicknameInfo.N.IoTID String No **** 00100 The ID of the device whose name you want to modify.

Note: When calling an API, in addition to the API-specific request parameters described in this topic, you must also pass in the common request parameters. For more information about common request parameters, see Common parameters.

Return data

Name Type Sample Values Description
Code String Iot.system.SystemException The error code returned when the call fails. For more information, see Error codes.
ErrorMessage String System Exception Error information returned when the call fails.
RequestID String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 The unique identifier generated for this request.
Success Boolean True Indicates whether the call succeeded. ●True : The call succeeded. ●False : The call failed.

Example

Request Example

curl 'https://si-d6******8958054.tuyacloud.com:8686/?Action=BatchUpdateDeviceNickname&SignatureNonce=4ac6922087e44a36ab17a7662d6368c9&AccessKeyId=xMr9wgwXQLhv5AUa65o03mcD&SignatureMethod=HMAC-SHA1&DeviceNicknameInfo.1.DeviceName=myTestDevice&Timestamp=2024-11-19T08%3A27%3A37Z&DeviceNicknameInfo.1.ProductKey=k1ymv1DuLfE&DeviceNicknameInfo.1.Nickname=myTestDeviceName&Signature=Rdv4rQ3Q6AS%2BMvDzF5zs9y0c8rQ%3D'

Normal return example

{
  "RequestId":"57b144cf-09fc-4916-a272-a62902d5b207",
  "Success": true
}