すべてのプロダクト
Search
ドキュメントセンター

IoT Platform:SetDevicesProperty

最終更新日:Apr 17, 2025

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

使用上の注意

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

QPS 制限

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

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

デバッグ

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

リクエストパラメーター

パラメーター必須説明
ActionStringはいSetDevicesProperty

実行する操作。値を SetDevicesProperty に設定します。

DeviceName.NRepeatListはいlight

プロパティを設定するデバイスの名前。有効な値:1 ~ 100。

ItemsStringはい{"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 モジュールはデフォルトモジュールではありません。
ProductKeyStringはいa1BwAGV****

デバイスが属するプロダクトの ProductKey

IotInstanceIdStringいいえiot_instc_pu****_c*-v64********

インスタンスの ID。インスタンスの ID は、IoT Platform コンソールの 概要 ページで確認できます。

重要
  • インスタンスに ID がある場合は、このパラメーターに ID を指定する必要があります。指定しないと、呼び出しは失敗します。
  • インスタンスに対して 概要 ページまたは ID が生成されていない場合は、このパラメーターを設定する必要はありません。

詳細については、「概要」をご参照ください。

QosIntegerいいえ1

メッセージのサービス品質 (QoS) レベル。有効な値:

  • 0 (デフォルト): システムはメッセージを最大 1 回送信します。
  • 1: システムはメッセージを少なくとも 1 回送信します。 QoS 1 メッセージをパブリッシュした後に PUBACK 応答が返されない場合、デバイスが IoT Platform に再接続したときにメッセージがデバイスに再送信されます。

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

レスポンスパラメーター

パラメーター説明
CodeStringiot.system.SystemException

呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。

ErrorMessageStringシステム例外が発生しました。

呼び出しが失敗した場合に返されるエラーメッセージ。

RequestIdStringE55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

リクエストの ID。

SuccessBooleantrue

呼び出しが成功したかどうかを示します。有効な値:

  • true: 呼び出しは成功しました。
  • false: 呼び出しは失敗しました。

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=SetDevicesProperty
&DeviceName.1=1102andriod02
&DeviceName.2=1102android01
&Items=%7B%20%20%20%20%20%22Data%22%3A%221372060916%22%2C%20%20%20%20%20%22Status%22%3A1%20%7D
&ProductKey=a1hWjHD****
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<SetDevicesPropertyResponse>
  <RequestId>2E19BDAF-0FD0-4608-9F41-82D230CFEE38</RequestId>
  <Success>true</Success>
</SetDevicesPropertyResponse>

JSON 形式

{
  "RequestId": "2E19BDAF-0FD0-4608-9F41-82D230CFEE38",
  "Success": true
}

エラーコード

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