SaveDeviceProp でデバイスタグを追加または変更 - IoT

デバイスのタグを指定します。

使用上の注意

1 つのデバイスに最大 100 個のタグを設定できます。
一度に最大 100 個のタグを変更または追加できます。

QPS 制限

Alibaba Cloud アカウントごとに、最大 50 クエリ/秒（QPS）を実行できます。

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

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	Yes	SaveDeviceProp	実行する操作。値を SaveDeviceProp に設定します。
Props	String	Yes	{"color":"red"}	デバイスに指定するタグ。複数のタグを指定できます。タグは、Key:Value 形式の JSON データである必要があります。 Key はタグ名を示し、Value はタグ値を示します。複数のタグはコンマ（,）で区切ります。例：Props={"color":"red","shape":"round"} 重要 Props パラメーターの最大サイズは 5 KB です。 `abc` は IoT Platform によって予約されている key です。Key を abc に設定することはできません。`Key` を abc に設定すると、タグをクエリするときに abc タグは自動的に除外されます。
IotInstanceId	String	No	iot_instc_pu***_c-v64********	インスタンスの ID。IoT Platform [概要] ページで、インスタンスの [ID] を表示できます。重要インスタンスに ID がある場合は、このパラメーターに ID を指定する必要があります。指定しないと、呼び出しは失敗します。 IoT Platform コンソールに [概要] ページまたはインスタンス ID が表示されない場合は、このパラメーターを設定する必要はありません。インスタンスの詳細については、「概要」をご参照ください。
ProductKey	String	No	a1BwAGV****	デバイスが属するプロダクトの ProductKey。説明このパラメーターを指定する場合は、DeviceName パラメーターも指定する必要があります。
DeviceName	String	No	light	デバイスの DeviceName。説明このパラメーターを指定する場合は、ProductKey パラメーターも指定する必要があります。
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	デバイスの ID。ID は、IoT Platform がデバイスに発行する一意の識別子です。説明このパラメーターを指定する場合は、ProductKey パラメーターまたは DeviceName パラメーターを指定する必要はありません。 IotId パラメーターは、デバイスのグローバル一意識別子（GUID）を指定します。 IotId パラメーターの値は、ProductKey パラメーターと DeviceName パラメーターの値の組み合わせに対応します。 IotId、ProductKey、および DeviceName パラメーターを指定した場合、IotId パラメーターの値が優先されます。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。エラーコードの詳細については、「エラーコード」をご参照ください。
ErrorMessage	String	A system exception occurred.	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=SaveDeviceProp
&ProductKey=a1BwAGV****
&DeviceName=device1
&Props=%7B%22color%22%3A%22red%22%7D
&<Common request parameters>

成功レスポンスの例

XML 形式

<SaveDevicePropResponse>
  <RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
  <Success>true</Success>
</SaveDevicePropResponse>

JSON 形式

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

エラーコード

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