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

デバイスのプロパティの目標値をクエリします。

使用上の注意

読み取り専用プロパティの目標値はクエリできません。
1 回の呼び出しで最大 10 個のプロパティの目標値をクエリできます。

QPS 制限

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

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

デバッグ

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

リクエストパラメーター

パラメーター	データ型	必須	例	説明
Action	String	Yes	QueryDeviceDesiredProperty	実行する操作。値を QueryDeviceDesiredProperty に設定します。
IotInstanceId	String	No	iot_instc_pu***_c-v64********	インスタンスの ID。IoT Platform コンソールの概要ページでインスタンスの ID を表示できます。重要インスタンスに ID がある場合は、このパラメーターに ID を指定する必要があります。指定しないと、呼び出しは失敗します。インスタンスに対して概要ページまたは ID が生成されない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。
ProductKey	String	No	a1BwAGV****	デバイスが属するプロダクトの ProductKey。説明このパラメーターに値を指定する場合は、DeviceName パラメーターを設定する必要があります。
DeviceName	String	No	light	デバイスの DeviceName。説明このパラメーターに値を指定する場合は、ProductKey パラメーターを設定する必要があります。
Identifier.N	RepeatList	No	Temperature	クエリするプロパティの識別子。プロパティ識別子を表示するには、IoT Platform コンソールの [プロダクトの詳細] ページの [機能定義] タブに移動します。 1 回の呼び出しで最大 10 個のプロパティ識別子を指定できます。各プロパティ識別子は一意である必要があります。このパラメーターを設定しない場合は、すべてのプロパティの目標値が返されます。
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	デバイスの ID。ID は、IoT Platform がデバイスに発行する一意の識別子です。説明このパラメーターに値を指定する場合は、ProductKey パラメーターまたは DeviceName パラメーターを設定する必要はありません。 IotId パラメーターは、デバイスの GUID を指定します。 IotId パラメーターの値は、ProductKey パラメーターと DeviceName パラメーターの値の組み合わせと同じです。 IotId パラメーター、ProductKey パラメーター、および DeviceName パラメーターに値を指定した場合、IotId パラメーターの値が優先されます。
FunctionBlockId	String	No	BatteryModule	カスタム TSL モジュールの識別子。各識別子は、プロダクト内で一意です。このパラメーターを設定しない場合、システムはデフォルトモジュールのデータをクエリします。

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

レスポンスパラメーター

パラメーター	データ型	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	Struct		呼び出しが成功した場合に List パラメーターで返されるデータ。
List	DesiredPropertyInfo の配列		DesiredPropertyInfo パラメーターで返される目標プロパティ情報。
DesiredPropertyInfo
DataType	String	int	プロパティのデータ型。
Identifier	String	Temperature	プロパティの識別子。
Name	String	airconditioning	プロパティの名前。
Time	String	1579335899000	プロパティの目標値が最後に変更された時刻。単位：ミリ秒。
Unit	String	°C	プロパティの単位。
Value	String	34	プロパティの目標値。説明 ClearDeviceDesiredProperty 操作を呼び出してプロパティの目標値を削除した場合、Value パラメーターは返されません。
Version	Long	1	目標値のバージョン。
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=QueryDeviceDesiredProperty
&IotId=SR8FiTu1R9tlUR2****0010300
&Identifier.1=Weight
&Identifier.2=Circle
&<Common request parameters>

成功レスポンスの例

XML 形式

<QueryDeviceDesiredPropertyResponse>
  <Data>
        <List>
              <DesiredPropertyInfo>
                    <Name>Temperature</Name>
                    <Value>35</Value>
                    <Time>1581778567154</Time>
                    <DataType>float</DataType>
                    <Version>1</Version>
                    <Identifier>Temperature</Identifier>
                    <Unit>°C</Unit>
              </DesiredPropertyInfo>
        </List>
  </Data>
  <RequestId>F0B1F7C8-A799-44C3-BDF8-1B8F9E91E675</RequestId>
  <Success>true</Success>
</QueryDeviceDesiredPropertyResponse>

JSON 形式

{
  "Data": {
    "List": {
      "DesiredPropertyInfo": [
        {
          "Name": "Temperature", 
          "Value": "35", 
          "Time": "1581778567154", 
          "DataType": "float", 
          "Version": 1, 
          "Identifier": "Temperature", 
          "Unit": "°C"
        }
      ]
    }
  }, 
  "RequestId": "F0B1F7C8-A799-44C3-BDF8-1B8F9E91E675", 
  "Success": true
}

エラーコード

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