调用该接口查询指定设备本身上报的原始事件(通过和未通过物模型校验的所有事件)记录。

限制说明

  • 如果在企业版实例中调用该接口,请求参数IotInstanceId必须填写。否则,调用接口会失败。
  • 仅能查询最近30天内的事件记录数据。
    说明 数据存储时间从事件生成当日起开始计算。
  • 单阿里云账号调用该接口的每秒请求数(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。
  • 公共实例:无需传入此参数。
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
}