指定されたデバイスによって送信されたイベントレコードをクエリします。これらのレコードには、指定された Thing Specification Language(TSL)モデルによって検証されたイベントと検証されていないイベントが含まれます。
制限
- 過去 30 日間に生成されたイベントレコードのみをクエリできます。
- 各 Alibaba Cloud アカウントは、最大 50 クエリ/秒(QPS)を実行できます。説明 Alibaba Cloud アカウントの Resource Access Management(RAM)ユーザーは、アカウントのクォータを共有します。
デバッグ
リクエストパラメーター
| パラメーター | タイプ | 必須 | 例 | 説明 |
| Action | String | はい | QueryDeviceOriginalEventData | 実行する操作。値を QueryDeviceOriginalEventData に設定します。 |
| Asc | Integer | はい | 0 | 返されるイベントレコードのソート順。有効な値:
|
| EndTime | Long | はい | 1516541900303 | クエリする時間範囲の終了。値はミリ秒単位の 13 桁のタイムスタンプです。 |
| Identifier | String | はい | PowerOff | クエリするイベント ID。
|
| PageSize | Integer | はい | 10 | 各ページに返すエントリの数。有効値: 1 ~ 50。デフォルト値: 10。 |
| StartTime | Long | はい | 1516538300303 | クエリする時間範囲の開始。値はミリ秒単位の 13 桁のタイムスタンプです。 |
| IotInstanceId | String | いいえ | iot_instc_pu****_c*-v64******** | インスタンスの ID。インスタンス ID は、IoT Platform コンソールの 概要 ページで確認できます。 重要
詳細については、「概要」をご参照ください。 |
| ProductKey | String | いいえ | a1BwAGV**** | デバイスが属するプロダクトの ProductKey。 説明 このパラメーターを指定する場合は、DeviceName パラメーターも指定する必要があります。 |
| DeviceName | String | いいえ | light | デバイスの名前。 説明 このパラメーターを指定する場合は、ProductKey パラメーターも指定する必要があります。 |
| NextPageToken | String | いいえ | Bo***x44Qx | 次のページの識別子。次のページが存在する場合、このパラメーターが返されます。この場合、次のリクエストにパラメーターの値を追加する必要があります。 |
| IotId | String | いいえ | Q7uOhVRdZRRlDnTLv****00100 | デバイスの ID。IoT Platform がデバイスに生成した一意の識別子です。 説明 このパラメーターを指定する場合は、ProductKey または DeviceName パラメーターを指定する必要はありません。IotId パラメーターは、デバイスの一意の識別子を指定し、ProductKey パラメーターと DeviceName パラメーターの組み合わせに対応します。IotId パラメーターと ProductKey パラメーターと DeviceName パラメーターの組み合わせを同時に指定した場合、IotId パラメーターのみが使用されます。 |
上記の操作固有のリクエストパラメーターに加えて、この API 操作を呼び出すときは、共通のリクエストパラメーターを指定する必要があります。共通リクエストパラメーターの詳細については、「共通パラメーター
レスポンスパラメーター
| パラメーター | タイプ | 例 | 説明 |
| Code | String | iot.device.InvalidIoTId | 呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。 |
| Data | 構造体 | 呼び出しが成功した場合に返されるイベントレコード。 | |
| List | EventInfo の配列 | イベントの配列。各要素はイベントを表します。イベントの詳細については、EventInfo パラメーターのパラメーターをご参照ください。 | |
| EventInfo | |||
| EventType | String | info | イベントのタイプ。有効な値:
|
| Identifier | String | PowerOff | イベントの識別子。 |
| Name | String | デバイスのシャットダウン | イベントの名前。 |
| OutputData | String | {"structArgs":{"structchildFLOATf71c20e":1.23}} | イベントの出力パラメーター。値は MAP 形式の文字列です。 |
| Time | String | 1579163099000 | イベントが発生した時刻。値はミリ秒単位の 13 桁のタイムスタンプです。 |
| NextPageToken | String | Bo***x44Qx | 次のページの識別子。 |
| NextValid | ブール値 | true | 次のページが存在するかどうかを示します。
値 trueNextPageToken パラメーターの値を次のリクエストに追加できます。これにより、現在のクエリに含まれていないデータをクエリできます。 |
| ErrorMessage | String | システム例外が発生しました。 | 呼び出しが失敗した場合に返されるエラーメッセージ。 |
| RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | リクエストの ID。 |
| Success | ブール値 | true | 呼び出しが成功したかどうかを示します。
|
例
リクエストの例
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 エラーセンター」をご参照ください。