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

複数のデバイスプロパティの期待値を一度に指定します。

使用方法

読み取り専用のプロパティの期待値はクエリできません。
1 回の呼び出しで最大 10 個の期待されるプロパティ値を指定できます。
デバイスの作成後、バージョン パラメータの値は 0 です。バージョン パラメータを初めて設定する場合、期待値を指定する際に バージョン パラメータを 0 に設定します。

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

QPS 制限

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

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

デバッグ

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

リクエストパラメータ

パラメータ	データ型	必須	例	説明
Action	String	はい	SetDeviceDesiredProperty	実行する操作。値を SetDeviceDesiredProperty に設定します。
Items	String	はい	{"Temperature":35}	指定するプロパティ値。このパラメータの値は JSON 文字列です。形式：キー:値。例：{"Temperature":35}。最大 10 個の期待されるプロパティ値を指定できます。キーはプロパティの識別子を指定します。プロパティ識別子は、IoT Platform コンソールの [機能の定義] タブにある [製品の詳細] ページで確認できます。また、QueryThingModel 操作を呼び出して、返された TSL データでプロパティ識別子を確認することもできます。温度プロパティが testFb という名前のカスタムモジュールに属している場合、このパラメータは {"testFb:temperature":35} に設定されます。説明指定されたプロパティは、読み取り/書き込みアクセスを許可する必要があります。読み取り専用のプロパティを指定すると、設定は失敗します。プロパティ識別子は一意である必要があります。値は、プロパティの期待値を指定します。値は、プロパティに定義されているデータ型と有効値範囲と一致する必要があります。説明値を null に設定すると、プロパティの期待値はクリアされます。
Versions	String	はい	{"Temperature":2}	期待されるプロパティ値のバージョン番号。このパラメータの値は JSON 文字列です。形式：キー:値。例：{"Temperature":2}。キー説明プロパティ ID は一意である必要があります。値は、期待されるプロパティ値のバージョン番号を指定します。期待されるプロパティ値を初めて指定する場合は、値パラメータを 0 に設定します。プロパティ値を設定した後、バージョン番号は 1 に変更されます。期待されるプロパティ値を指定するたびに、IoT Platform はバージョン番号を 1 ずつ自動的に増やします。期待されるプロパティ値を 2 回目に指定すると、バージョン番号は 2 に変更されます。期待されるプロパティ値を 3 回目に指定する場合は、バージョン番号を 2 に設定します。期待されるプロパティ値を指定した後、バージョン番号は 3 に変更されます。説明このパラメータに指定したバージョン番号が現在のバージョン番号でない場合、サーバーはリクエストを拒否します。現在のバージョン番号がわからない場合は、バージョン番号を指定する必要はありません。ただし、有効な JSON オブジェクト {} を入力する必要があります。
IotInstanceId	String	いいえ	iot_instc_pu***_c-v64********	インスタンス ID。インスタンス ID は、IoT Platform コンソールの概要ページで確認できます。重要インスタンスに ID がある場合は、このパラメータに ID を指定する必要があります。そうでない場合、呼び出しは失敗します。インスタンスに対して概要ページまたは ID が生成されていない場合は、このパラメータを設定する必要はありません。詳細については、「概要」をご参照ください。
IotId	String	いいえ	Q7uOhVRdZRRlDnTLv****00100	デバイスの ID。ID は、IoT Platform がデバイスに発行する一意の識別子です。重要 IotId パラメータは、デバイスのグローバル一意識別子（GUID）を指定します。IotId パラメータの値は、ProductKey パラメータと DeviceName パラメータの値の組み合わせに対応します。このパラメータの値を指定する場合は、ProductKey パラメータまたは DeviceName パラメータを指定する必要はありません。IotId パラメータ、ProductKey パラメータ、および DeviceName パラメータの値を指定した場合、IotId パラメータの値が優先されます。
DeviceName	String	いいえ	light	デバイスの名前。重要このパラメータの値を指定する場合は、ProductKey パラメータの値も指定する必要があります。
ProductKey	String	いいえ	a1BwAGV****	デバイスが属するプロダクトの ProductKey。重要このパラメータを設定する場合は、DeviceName パラメータの値も指定する必要があります。

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

レスポンスパラメータ

パラメータ	データ型	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	Struct		呼び出しが成功した場合に返されるデータ。詳細については、以下のパラメータを参照してください。
MessageId	String	300511751	IoT Platform が期待値を指定するためにデバイスに送信するメッセージの ID。
Versions	String	{\"Temperature\":2}	期待されるプロパティ値の現在のバージョン番号。
ErrorMessage	String	システム例外が発生しました。	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。有効な値： true：呼び出しは成功しました。 false：呼び出しは失敗しました。

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=SetDeviceDesiredProperty
&ProductKey=a1BwAGV****
&DeviceName=device1
&Items=%7B%22LightAdjustLevel%22%3A1%7D
&Versions=%7B%22LightAdjustLevel%22%3A10%7D
&<共通リクエストパラメータ>

成功レスポンスの例

XML 形式

<SetDeviceDesiredPropertyResponse>
  <Data>
        <MessageId>300511751</MessageId>
        <Versions>{"LightAdjustLevel":2}</Versions>
  </Data>
  <RequestId>AADE79D2-B328-4FC6-A3E0-34BB23BCA440</RequestId>
  <Success>true</Success>
</SetDeviceDesiredPropertyResponse>

JSON 形式

{
    "Data": {
        "MessageId": "300511751",
        "Versions": "{\"LightAdjustLeve\":2}"
    },
    "RequestId": "AADE79D2-B328-4FC6-A3E0-34BB23BCA440",
    "Success": true
}

エラーコード

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