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

デバイスのプロパティの値を指定します。

使用方法

IoT Platform がデバイスのプロパティを設定するリクエストを送信した後、デバイスは非同期でリクエストを受信して処理します。この操作を呼び出すと、成功応答は IoT Platform がリクエストを送信したことを示します。応答は、デバイスがリクエストを受信して処理したことを示すものではありません。デバイス SDK がリクエストに応答した後、デバイスのプロパティが設定されます。

重要 Thing Specification Language（TSL）データが float 型または double 型の場合、TSL データに対応するパラメーター値には、少なくとも 1 つの小数点以下の桁数が含まれます。例：10.0 と 11.1。

QPS 制限

この API 操作は、アカウントごとに 1 秒あたり最大 500 回呼び出すことができます。

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

デバッグ

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

リクエストパラメーター

パラメーター	データ型	必須	例	説明
Action	String	はい	SetDeviceProperty	実行する操作。値を SetDeviceProperty に設定します。
Items	String	はい	{"Switch":1,"Color":"blue"}	設定するプロパティ。プロパティは JSON 形式である必要があります。各プロパティは、key:value 形式のプロパティ ID とプロパティ値の組み合わせで構成されます。複数のプロパティはコンマ（,）で区切ります。たとえば、スマートランプには次のプロパティを設定できます。キーが Switch で、データ型が BOOLEAN のスイッチプロパティ。値は 1 です。値 1 は、ライトが点灯していることを示します。キーが Color で、データ型が STRING のカラープロパティ。値は blue です。この場合、JSON 形式で次のプロパティを設定できます。 `Items={"Switch":1,"Color":"blue"}` 説明カスタムモジュール testFb のプロパティを設定する場合は、`Items={"testFb:Switch":1,"testFb:Color":"blue"}` を指定します。 testFb モジュールはデフォルトモジュールではありません。
IotInstanceId	String	いいえ	iot-v64*****	インスタンスの ID。インスタンスの ID は、IoT Platform コンソールの概要ページで確認できます。重要インスタンスに ID がある場合は、このパラメーターに ID を指定する必要があります。指定しないと、呼び出しは失敗します。インスタンスに概要ページまたは ID が生成されていない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。
ProductKey	String	いいえ	a1BwAGV****	デバイスが属するプロダクトの ProductKey。重要このパラメーターに値を指定する場合は、DeviceName パラメーターを設定する必要があります。
DeviceName	String	いいえ	light	デバイスの DeviceName。重要このパラメーターを設定する場合は、ProductKey パラメーターに値を指定する必要があります。
IotId	String	いいえ	Q7uOhVRdZRRlDnTLv****00100	デバイスの ID。 ID は、IoT Platform がデバイスに発行する一意の識別子です。重要 IotId パラメーターは、デバイスの GUID を指定します。 IotId パラメーターの値は、ProductKey パラメーターと DeviceName パラメーターの値の組み合わせと同じです。 IotId パラメーターに値を指定する場合は、ProductKey パラメーターと DeviceName パラメーターに値を指定する必要はありません。 IotId パラメーター、ProductKey パラメーター、および DeviceName パラメーターに値を指定した場合、IotId パラメーターの値が優先されます。
Qos	Integer	いいえ	1	メッセージのサービス品質（QoS）レベル。有効な値： 0（デフォルト）：システムはメッセージを最大 1 回送信します。 1：システムはメッセージを少なくとも 1 回送信します。 QoS 1 メッセージをパブリッシュした後に PUBACK 応答が返されない場合、デバイスが IoT Platform に再接続したときにメッセージがデバイスに再送信されます。

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

レスポンスパラメーター

パラメーター	データ型	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	Struct		呼び出しが成功した場合に返されるデータ。
MessageId	String	abcabc123	IoT Platform がデバイスに送信するメッセージの ID。
ErrorMessage	String	システム例外が発生しました。	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。有効な値： true：呼び出しは成功しました。 false：呼び出しは失敗しました。

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=SetDeviceProperty
&ProductKey=a1BwAGV****
&DeviceName=device1
&Items={"Switch":1,"Color":"blue"}
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<SetDevicePropertyResponse>
  <RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
  <Success>true</Success>
  <Data>
        <MessageId>abcabc123</MessageId>
  </Data>
</SetDevicePropertyResponse>

JSON 形式

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

エラーコード

エラーコードのリストについては、「サービスエラーコード」をご参照ください。