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

指定されたデバイスのイベントレコードをクエリします。

使用方法

過去 30 日間に生成されたイベントレコードのみをクエリできます。

説明イベントレコードの保存期間は、レコードが生成された日から計算されます。

QPS 制限

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

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

デバッグ

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	はい	QueryDeviceEventData	実行する操作。値を QueryDeviceEventData に設定します。
EndTime	Long	はい	1516541900303	クエリする時間範囲の終了時刻。値はミリ秒単位の 13 桁のタイムスタンプです。例：1516541900303。
StartTime	Long	はい	1516541900303	クエリする時間範囲の開始時刻。値はミリ秒単位の 13 桁のタイムスタンプです。例：1516538300303。説明直近 30 日間のイベントデータのみクエリできます。
IotInstanceId	String	いいえ	iot_instc_pu***_c-v64********	インスタンスの ID。IoT Platform コンソールの概要ページでインスタンスの ID を確認できます。重要インスタンスに ID がある場合は、このパラメーターを指定する必要があります。指定しないと、呼び出しは失敗します。 IoT Platform コンソールに概要ページが表示されない場合、またはインスタンスの ID が生成されない場合は、このパラメーターを指定する必要はありません。詳細については、「概要」をご参照ください。
PageSize	Integer	いいえ	10	各ページに戻すエントリの数。有効値：1 ～ 50。デフォルト値：10。
ProductKey	String	いいえ	a1BwAGV****	デバイスが属するプロダクトの ProductKey。説明このパラメーターを指定する場合は、DeviceName パラメーターも指定する必要があります。
DeviceName	String	いいえ	light	デバイスの DeviceName。説明このパラメーターの値を指定する場合は、ProductKey パラメーターの値も指定する必要があります。
Identifier	String	いいえ	PowerOff	クエリするイベントの識別子。IoT Platform コンソールの [プロダクトの詳細] ページの [機能の定義] タブでイベント識別子を確認できます。また、QueryThingModel 操作を呼び出して、返された TSL データでイベント識別子を確認することもできます。説明 PowerOff イベントが testFb という名前のカスタムモジュールに属している場合、このパラメーターは testFb:PowerOff に設定されます。このパラメーターを指定しない場合、システムはデフォルトモジュールのすべてのイベントデータをクエリします。
EventType	String	いいえ	info	クエリするイベントのタイプ。有効値： info: 情報。 alert: アラート。 error: エラー。
Asc	Integer	いいえ	0	返されたイベントレコードをソートする順序。有効値： 0: 逆時系列順。これはデフォルト値です。 1: 時系列順。説明このパラメーターを設定しない場合、デフォルト値 0 が使用されます。システムは、返されたイベントレコードを逆時系列順にソートします。
IotId	String	いいえ	Q7uOhVRdZRRlDnTLv****00100	デバイスの ID。ID は、IoT Platform がデバイスに発行する一意の識別子です。説明このパラメーターの値を指定する場合は、ProductKey パラメーターまたは DeviceName パラメーターの値を指定する必要はありません。IotId パラメーターは、デバイスのグローバル一意識別子（GUID）を指定します。 IotId パラメーターの値は、ProductKey パラメーターと DeviceName パラメーターの値の組み合わせに対応します。IotId パラメーターの値と ProductKey パラメーターと DeviceName パラメーターの値を指定した場合、IotId パラメーターの値が優先されます。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	Struct		呼び出しが成功した場合に返されるイベントレコード。
List	EventInfo の配列		イベントの配列。各要素はイベントを表します。
EventInfo
EventType	String	info	イベントのタイプ。有効値： info: 情報。 alert: アラート。 error: エラー。
Identifier	String	PowerOff	イベントの識別子。
Name	String	Device shutdown	イベントの名前。
OutputData	String	null	イベントの出力パラメーター。値は MAP 形式の文字列です。
Time	String	1579163099000	イベントが発生した時刻。値はミリ秒単位のタイムスタンプです。
NextTime	Long	1579163099000	次のページのイベントレコードの開始時刻。値はミリ秒単位のタイムスタンプです。 Asc パラメーターが 0 に設定されている場合、この操作を再度呼び出して次のページのイベントレコードをクエリするときに、この値を EndTime パラメーターに指定できます。 Asc パラメーターが 1 に設定されている場合、この操作を再度呼び出して次のページのイベントレコードをクエリするときに、この値を StartTime パラメーターに指定できます。
NextValid	Boolean	true	次のページが存在するかどうかを示します。 true: 次のページが存在します。NextTime パラメーターの値が返されます。詳細については、このトピックの NextTime パラメーターの説明をご参照ください。 false: 次のページは存在しません。
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=QueryDeviceEventData
&IotId=abcdef1234567************
&ProductKey=al**********
&DeviceName=device1
&EventType=info
&Identifier=lightLevel
&StartTime=1516538300303
&EndTime=1516541900303
&PageSize=10
&Asc=1
&<Common request parameters>

成功レスポンスの例

XML 形式

<QueryDeviceEventDataResponse>
  <Data>
        <NextValid>false</NextValid>
        <NextTime>1579249151177</NextTime>
        <List>
              <EventInfo>
                    <Name>testEventInfoName</Name>
                    <Time>1516517974638</Time>
                    <OutputData>{"structArgs":{"structchildFLOATf71c20e":1.23,"structchildINT6b6b626":3,"structchildDATE663436a":"1516517966152","structchildDOUBLE08d0f74":1.23,"structchildTEXTdc764f9":"07b68264b0ba42c18e5f","structchildBOOLd260729":0,"structchildENUMbe62590":1},"enumArgs":0,"boolArgs":0,"floatArgs":2.3,"dateArgs":"1516517966152","intArgs":1,"doubleArgs":2.3,"textArgs":"dV56zbkzjBjw1Ti1dA52"}</OutputData>
                    <EventType>info</EventType>
                    <Identifier>testEventInfo</Identifier>
              </EventInfo>
        </List>
  </Data>
  <RequestId>45391E10-446B-4986-863E-1BA8CC44748F</RequestId>
  <Success>true</Success>
</QueryDeviceEventDataResponse>

JSON 形式

{
  "Data": {
    "NextValid": false, 
    "NextTime": 1579249151177, 
    "List": {
      "EventInfo": [
        {
          "Name": "testEventInfoName", 
          "Time": 1516517974638, 
          "OutputData": "{\"structArgs\":{\"structchildFLOATf71c20e\":1.23,\"structchildINT6b6b626\":3,\"structchildDATE663436a\":\"1516517966152\",\"structchildDOUBLE08d0f74\":1.23,\"structchildTEXTdc764f9\":\"07b68264b0ba42c18e5f\",\"structchildBOOLd260729\":0,\"structchildENUMbe62590\":1},\"enumArgs\":0,\"boolArgs\":0,\"floatArgs\":2.3,\"dateArgs\":\"1516517966152\",\"intArgs\":1,\"doubleArgs\":2.3,\"textArgs\":\"dV56zbkzjBjw1Ti1dA52\"}", 
          "EventType": "info", 
          "Identifier": "testEventInfo"
        }
      ]
    }
  }, 
  "RequestId": "45391E10-446B-4986-863E-1BA8CC44748F", 
  "Success": true
}

エラーコード

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