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

デバイスまたはデジタルツインノードのプロパティのスナップショットをすべてクエリします。

使用方法

デジタルツインノードのプロパティデータをクエリするには、IotId パラメーターをデジタルツインノードの ID に設定する必要があります。

QPS 制限

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

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

デバッグ

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	はい	QueryDevicePropertyStatus	実行する操作。値を QueryDevicePropertyStatus に設定します。
IotInstanceId	String	いいえ	iot_instc_pu***_c-v64********	インスタンスの ID。 IoT Platform コンソールの [概要] ページでインスタンスの [ID] を表示できます。重要インスタンスに ID がある場合は、このパラメーターに ID を指定する必要があります。指定しないと、呼び出しは失敗します。コンソールに概要ページまたはインスタンス ID が表示されない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。
ProductKey	String	いいえ	a1BwAGV****	デバイスが属するプロダクトの ProductKey。重要このパラメーターを指定する場合は、DeviceName パラメーターも指定する必要があります。
DeviceName	String	いいえ	light	デバイスの DeviceName。重要このパラメーターを指定する場合は、ProductKey パラメーターも指定する必要があります。
IotId	String	いいえ	Q7uOhVRdZRRlDnTLv****00100	プロパティデータをクエリするデバイスまたはデジタルツインノードの ID。 QueryDeviceInfo 操作を呼び出して、デバイスの ID をクエリできます。 IoT Platform コンソールにログインします。 [ツインの詳細] ページで、デジタルツインノードをクリックしてその ID を表示します。重要このパラメーターを指定する場合は、ProductKey パラメーターと DeviceName パラメーターを指定する必要はありません。 IotId パラメーターは、デバイスのグローバル一意識別子（GUID）を指定します。 IotId パラメーターの値は、ProductKey パラメーターと DeviceName パラメーターの値の組み合わせに対応します。 IotId、ProductKey、および DeviceName パラメーターを指定した場合、IotId パラメーターの値が優先されます。
FunctionBlockId	String	いいえ	BatteryModule	カスタム TSL モジュールの識別子。各識別子は、プロダクト内で一意です。このパラメーターを指定しない場合、システムはデフォルトモジュールのデータをクエリします。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	構造体		呼び出しが成功した場合に返されるデータ。詳細については、リストをご参照ください。
List	PropertyStatusInfo の配列		プロパティ情報の配列。各プロパティに関する情報は、PropertyStatusInfo パラメーターによって示されます。
PropertyStatusInfo
DataType	String	int	プロパティのデータ型。有効な値： int: 整数 float: 単精度浮動小数点数 double: 倍精度浮動小数点数 enum: 列挙型 bool: ブール値 text: 文字 date: 時刻（ミリ秒単位の文字列型の UTC タイムスタンプ） array: 配列 struct: 構造体
Identifier	String	Temperature	プロパティの識別子。
Name	String	temperature	プロパティの名前。
Time	String	1517553572362	プロパティが変更された時刻（ミリ秒単位）。
Unit	String	°C	プロパティ値の単位。
Value	String	25	プロパティの値。
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=QueryDevicePropertyStatus
&ProductKey=a1rYuVF****
&DeviceName=device1
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<QueryDevicePropertyStatusResponse>
  <Data>
        <List>
              <PropertyStatusInfo>
                    <Name>Humidity</Name>
                    <Value>48</Value>
                    <Time>1579249151178</Time>
                    <DataType>int</DataType>
                    <Identifier>Humidity</Identifier>
                    <Unit>%</Unit>
              </PropertyStatusInfo>
              <PropertyStatusInfo>
                    <Name> Temperature</Name>
                    <Value>32.46</Value>
                    <Time>1579249151178</Time>
                    <DataType>float</DataType>
                    <Identifier>Temperature</Identifier>
                    <Unit>°C</Unit>
              </PropertyStatusInfo>
        </List>
  </Data>
  <RequestId>84BAD25B-9879-4BA1-9213-F576C6558D77</RequestId>
  <Success>true</Success>
</QueryDevicePropertyStatusResponse>

JSON 形式

{
    "Data": {
        "List": {
            "PropertyStatusInfo": [
                {
                    "Name": "Humidity",
                    "Value": "48",
                    "Time": "1579249151178",
                    "DataType": "int",
                    "Identifier": "Humidity",
                    "Unit": "%"
                },
                {
                    "Name": "Temperature",
                    "Value": "32.46",
                    "Time": "1579249151178",
                    "DataType": "float",
                    "Identifier": "Temperature",
                    "Unit": "°C"
                }
            ]
        }
    },
    "RequestId": "84BAD25B-9879-4BA1-9213-F576C6558D77",
    "Success": true
}

エラーコード

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