全部產品
Search
文件中心

IoT Platform:QueryDeviceOriginalEventData

更新時間:Feb 14, 2025

調用該介面查詢指定裝置本身上報的原始事件(通過和未通過物模型校正的所有事件)記錄。

使用說明

僅能查詢最近30天內的事件記錄資料。

說明 資料存放區時間從事件產生當日起開始計算。

QPS限制

單個阿里雲帳號調用該介面的每秒請求數(QPS)最大限制為50。

說明 RAM使用者共用阿里雲帳號配額。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱 類型 是否必選 樣本值 描述
Action String QueryDeviceOriginalEventData

系統規定參數。取值:QueryDeviceOriginalEventData。

Asc Integer 0

指定返回結果中事件記錄的排序方式,取值:

  • 0:倒序。
  • 1:正序。
EndTime Long 1516541900303

要查詢的事件記錄的結束時間。格式為毫秒級的13位時間戳記。

Identifier String PowerOff

要查詢的事件標識符。

  • 對於弱校正,裝置的事件Identifier,可在控制台中裝置所屬的產品的功能定義中查看;也可以調用QueryThingModel,從返回的物模型資訊中查看。
  • 對於免校正,必須與裝置事件上報時自訂的identifier一致。
PageSize Integer 10

返回結果中每頁顯示的記錄數。數量限制:每頁最多可顯示50條。預設值是10。

StartTime Long 1516538300303

要查詢的事件記錄的開始時間。格式為毫秒級的13位時間戳記。

IotInstanceId String iot_instc_pu****_c*-v64********

執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面,查看當前執行個體的ID

重要
  • 若有ID值,必須傳入該ID值,否則調用會失敗。
  • 若無執行個體概覽頁面或ID值,則無需傳入。

執行個體的更多資訊,請參見執行個體概述

ProductKey String a1BwAGV****

要查詢裝置所屬的產品ProductKey

說明 如果傳入該參數,需同時傳入DeviceName
DeviceName String light

要查詢的裝置名稱。

說明 如果傳入該參數,需同時傳入ProductKey
NextPageToken String Bo***x44Qx

下一頁標識。如果存在下一頁,服務會返回此token,下次請求帶上即可。

IotId String Q7uOhVRdZRRlDnTLv****00100

要查詢的裝置ID。物聯網平台為該裝置頒發的ID,裝置的唯一識別碼。

說明 如果傳入該參數,則無需傳入ProductKeyDeviceNameIotId作為裝置唯一識別碼,和ProductKeyDeviceName組合是一一對應的關係。如果您同時傳入IotIdProductKeyDeviceName組合,則以IotId為準。

調用API時,除了本文介紹的該API的特有請求參數,還需傳入公用請求參數。公用請求參數說明,請參見公用參數文檔

返回資料

名稱 類型 樣本值 描述
Code String iot.device.InvalidIoTId

調用失敗時,返回的錯誤碼。更多資訊,請參見錯誤碼

Data Struct

調用成功時,返回的裝置事件記錄。

List Array of EventInfo

事件集合。每個元素代表一個事件。事件詳情請參見EventInfo下參數。

EventInfo
EventType String info

事件類型。

  • info:資訊。
  • alert:警示。
  • error:故障。
Identifier String PowerOff

事件標識符。

Name String 裝置關機

事件名稱。

OutputData String {"structArgs":{"structchildFLOATf71c20e":1.23}}

事件的輸出參數,MAP格式的字串。

Time String 1579163099000

事件發生時間。毫秒級的13位時間戳記。

NextPageToken String Bo***x44Qx

下一頁標識。

NextValid Boolean true

是否有下一頁屬性記錄。

  • true:有。
  • false:沒有。

返回NextValidtrue時,可以將NextPageToken的值作為下次查詢的NextPageToken,繼續查詢本次查詢不顯示的資料。

ErrorMessage String 系統異常

調用失敗時,返回的出錯資訊。

RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

阿里雲為該請求產生的唯一識別碼。

Success Boolean 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
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。