BatchUpdateDeviceNickname - IoT Platform - Alibaba Cloud ドキュメントセンター

複数のデバイスのエイリアスを変更します。

制限

各 Alibaba Cloud アカウントは、最大 10 クエリ/秒（QPS）を実行できます。

説明 Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。

デバッグ

Alibaba Cloud は、API の使用を簡素化するために OpenAPI Explorer を提供しています。 OpenAPI Explorer は署名の値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK 用の操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	Yes	BatchUpdateDeviceNickname	実行する操作。値を BatchUpdateDeviceNickname に設定します。
IotInstanceId	String	No	iot_instc_pu***_c-v64********	インスタンスの ID。インスタンス ID は、IoT Platform コンソールの概要ページで確認できます。重要インスタンスに ID がある場合は、このパラメーターを設定する必要があります。このパラメーターを設定しないと、呼び出しは失敗します。インスタンスに概要ページまたは ID がない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。
DeviceNicknameInfo.N.ProductKey	String	No	a1BwAGV****	デバイスが属するプロダクトの ProductKey。説明このパラメーターを指定する場合は、DeviceName パラメーターも指定する必要があります。
DeviceNicknameInfo.N.DeviceName	String	No	light	デバイスの DeviceName。説明このパラメーターを指定する場合は、ProductKey パラメーターも指定する必要があります。
DeviceNicknameInfo.N.Nickname	String	No	AliyunDataCenter	デバイスの新しいエイリアス。エイリアスは 4 ～ 32 文字で、文字、数字、およびアンダースコア（_）を含めることができます。各中国語の文字は 2 文字としてカウントされます。説明このパラメーターを指定しないと、デバイスの元のエイリアスは削除されます。
DeviceNicknameInfo.N.IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	デバイスの ID。説明このパラメーターを指定する場合は、ProductKey または DeviceName を指定する必要はありません。 IotId パラメーターは、デバイスのグローバル一意識別子（GUID）を指定します。これは、ProductKey と DeviceName の組み合わせに対応します。 IotId と ProductKey と DeviceName の組み合わせの両方を指定した場合、IotId が優先されます。

上記の操作固有のリクエストパラメーターに加えて、この操作を呼び出すときは、共通のリクエストパラメーターを指定する必要があります。詳細については、「共通リクエストパラメーター」をご参照ください。

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
ErrorMessage	String	システム例外が発生しました。	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	リクエストの ID。
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
}

エラーコード

エラーコードのリストについては、API エラーセンターをご覧ください。