調用接口QueryDeviceEventData查詢指定設備的事件記錄。
使用說明
- 標準型和尊享型企業版實例:僅可查詢存儲時效內的數據。數據存儲時效,請參見存儲配置。
- 其他實例:僅可查詢最近30天內的屬性數據。
QPS限制
單個阿里云賬號調用該接口的每秒請求數(QPS)最大限制為50。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | QueryDeviceEventData | 系統規定參數。取值:QueryDeviceEventData。 |
EndTime | Long | 是 | 1516541900303 | 要查詢的事件記錄的結束時間。格式為毫秒級的13位時間戳,例如:1516541900303。 |
StartTime | Long | 是 | 1516541900303 | 要查詢的事件記錄的開始時間。格式為毫秒級的13位時間戳,例如:1516538300303。 |
IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** | 實例ID。您可在物聯網平臺控制臺的實例概覽頁面,查看當前實例的ID。 重要
實例的更多信息,請參見實例概述。 |
PageSize | Integer | 否 | 10 | 返回結果中每頁顯示的記錄數。數量限制:每頁最多可顯示50條。默認值是10。 |
ProductKey | String | 否 | a1BwAGV**** | 要查詢的設備所屬的產品ProductKey。 重要 如果傳入該參數,需同時傳入DeviceName。
|
DeviceName | String | 否 | light | 要查詢的設備名稱。 重要 如果傳入該參數,需同時傳入ProductKey。
|
Identifier | String | 否 | PowerOff | 要查詢的事件標識符。設備的事件Identifier,可在控制臺中設備所屬的產品的功能定義中查看;也可以調用QueryThingModel,從返回的物模型信息中查看。 說明 如果是自定義(非默認)模塊testFb下事件PowerOff,則參數值為testFb:PowerOff。 不傳入此參數時,查詢默認模塊下的所有事件數據。 |
EventType | String | 否 | info | 要查詢的事件類型。取值:
|
Asc | Integer | 否 | 0 | 返回結果中事件記錄的排序方式,取值:
說明 不傳入此參數時,使用默認值0,按照倒序進行排序。 |
IotId | String | 否 | Q7uOhVRdZRRlDnTLv****00100 | 要查詢的設備ID。物聯網平臺為該設備頒發的ID,設備的唯一標識符。 重要 IotId作為設備唯一標識符,和ProductKey與DeviceName組合是一一對應的關系。如果傳入該參數,則無需傳入ProductKey和DeviceName。如果您同時傳入IotId和ProductKey與DeviceName組合,則以IotId為準。
|
調用API時,除了本文介紹的該API的特有請求參數,還需傳入公共請求參數。公共請求參數說明,請參見公共參數文檔。
返回數據
名稱 |
類型 |
示例值 |
描述 |
Code | String | iot.system.SystemException | 調用失敗時,返回的錯誤碼。更多信息,請參見錯誤碼。 |
Data | Struct | 調用成功時,返回的設備事件記錄。 |
|
List | Array of EventInfo | 事件集合。每個元素代表一個事件。 |
|
EventInfo | |||
EventType | String | info | 事件類型。
|
Identifier | String | PowerOff | 事件標識符。 |
Name | String | 設備關機 | 事件名稱。 |
OutputData | String | {"structArgs":{"structchildFLOATf71c20e":1.23}} | 事件的輸出參數,map格式的字符串。 |
Time | String | 1579163099000 | 事件發生時間。毫秒級時間戳。 |
NextTime | Long | 1579163099000 | 下一頁面中的事件記錄的起始時間。毫秒級時間戳。
|
NextValid | Boolean | true | 是否有下一頁事件記錄。
|
ErrorMessage | String | 系統異常 | 調用失敗時,返回的出錯信息。 |
RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | 阿里云為該請求生成的唯一標識符。 |
Success | Boolean | true | 表示是否調用成功。
|
示例
請求示例
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
&<公共請求參數>
正常返回示例
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
}