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

IoT Platform:QueryDeviceOriginalEventData

最終更新日:Apr 17, 2025

指定されたデバイスによって送信されたイベントレコードをクエリします。これらのレコードには、指定された Thing Specification Language(TSL)モデルによって検証されたイベントと検証されていないイベントが含まれます。

制限

  • 過去 30 日間に生成されたイベントレコードのみをクエリできます。
説明 イベントレコードの保存期間は、レコードが生成された日から計算されます。
  • 各 Alibaba Cloud アカウントは、最大 50 クエリ/秒(QPS)を実行できます。
    説明 Alibaba Cloud アカウントの Resource Access Management(RAM)ユーザーは、アカウントのクォータを共有します。

デバッグ

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

リクエストパラメーター

パラメータータイプ必須説明
ActionStringはいQueryDeviceOriginalEventData

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

AscIntegerはい0

返されるイベントレコードのソート順。有効な値:

  • 0: 降順。
  • 1: 昇順。
EndTimeLongはい1516541900303

クエリする時間範囲の終了。値はミリ秒単位の 13 桁のタイムスタンプです。

IdentifierStringはいPowerOff

クエリするイベント ID。

  • 低レベルの検証が適用されている場合、次の手順を実行してデバイスイベントの Identifier を表示できます。IoT Platform コンソールにログインし、[製品の詳細] ページの [機能の定義] タブに移動します。また、QueryThingModel 操作を呼び出して、返された TSL データのサービス ID を表示することもできます。
  • 検証が適用されていない場合、値はデバイスによって送信されたカスタム ID の値と同じである必要があります。
PageSizeIntegerはい10

各ページに返すエントリの数。有効値: 1 ~ 50。デフォルト値: 10。

StartTimeLongはい1516538300303

クエリする時間範囲の開始。値はミリ秒単位の 13 桁のタイムスタンプです。

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

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

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

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

ProductKeyStringいいえa1BwAGV****

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

説明 このパラメーターを指定する場合は、DeviceName パラメーターも指定する必要があります。
DeviceNameStringいいえlight

デバイスの名前。

説明 このパラメーターを指定する場合は、ProductKey パラメーターも指定する必要があります。
NextPageTokenStringいいえBo***x44Qx

次のページの識別子。次のページが存在する場合、このパラメーターが返されます。この場合、次のリクエストにパラメーターの値を追加する必要があります。

IotIdStringいいえQ7uOhVRdZRRlDnTLv****00100

デバイスの ID。IoT Platform がデバイスに生成した一意の識別子です。

説明 このパラメーターを指定する場合は、ProductKey または DeviceName パラメーターを指定する必要はありません。IotId パラメーターは、デバイスの一意の識別子を指定し、ProductKey パラメーターと DeviceName パラメーターの組み合わせに対応します。IotId パラメーターと ProductKey パラメーターと DeviceName パラメーターの組み合わせを同時に指定した場合、IotId パラメーターのみが使用されます。

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

レスポンスパラメーター

パラメータータイプ説明
CodeStringiot.device.InvalidIoTId

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

Data構造体

呼び出しが成功した場合に返されるイベントレコード。

ListEventInfo の配列

イベントの配列。各要素はイベントを表します。イベントの詳細については、EventInfo パラメーターのパラメーターをご参照ください。

EventInfo
EventTypeStringinfo

イベントのタイプ。有効な値:

  • info: 情報。
  • alert: アラート。
  • error: エラー。
IdentifierStringPowerOff

イベントの識別子。

NameStringデバイスのシャットダウン

イベントの名前。

OutputDataString{"structArgs":{"structchildFLOATf71c20e":1.23}}

イベントの出力パラメーター。値は MAP 形式の文字列です。

TimeString1579163099000

イベントが発生した時刻。値はミリ秒単位の 13 桁のタイムスタンプです。

NextPageTokenStringBo***x44Qx

次のページの識別子。

NextValidブール値true

次のページが存在するかどうかを示します。

  • true: 次のページが存在します。
  • false: 次のページは存在しません。

trueNextPageToken パラメーターの値を次のリクエストに追加できます。これにより、現在のクエリに含まれていないデータをクエリできます。

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

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

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

リクエストの ID。

Successブール値true

呼び出しが成功したかどうかを示します。

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

リクエストの例

http(s)://iot.cn-shanghai.aliyuncs.com/? Action=QueryDeviceOriginalEventData
&Asc=0
&EndTime=1516541900303
&Identifier=PowerOff
&PageSize=10
&StartTime=1516538300303
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<QueryDeviceOriginalEventDataResponse>
  <Data>
        <NextValid>false</NextValid>
        <NextTime>Bo***x44Qx</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>
</QueryDeviceOriginalEventDataResponse>

JSON 形式

{
  "Data": {
    "NextValid": false, 
    "NextPageToken": "Bo***x44Qx", 
    "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 エラーセンター」をご参照ください。