QueryDeviceOriginalEventData - IoT Platform - Centro de documentación de Alibaba Cloud

Consulta los registros de eventos enviados por un dispositivo específico. Estos registros incluyen eventos verificados y no verificados por un modelo de Thing Specification Language (TSL) determinado.

Límites

Solo se pueden consultar los registros de eventos generados en los últimos 30 días.

Nota

El periodo de almacenamiento de un registro de evento se calcula a partir del día en que se genera el registro.

Cada cuenta de Alibaba Cloud puede ejecutar un máximo de 50 consultas por segundo (QPS).

Nota
Los usuarios de Resource Access Management (RAM) de una cuenta de Alibaba Cloud comparten la cuota de dicha cuenta.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para mayor comodidad, se recomienda llamar a esta operación desde OpenAPI Explorer. Esta herramienta genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	QueryDeviceOriginalEventData	La operación que desea ejecutar. Establezca el valor en QueryDeviceOriginalEventData.
Asc	Integer	Sí	0	El orden de clasificación de los registros de eventos devueltos. Valores válidos: 0: descendente. 1: ascendente.
EndTime	Long	Sí	1516541900303	El final del intervalo de tiempo que se va a consultar. El valor es una marca de tiempo de 13 dígitos en milisegundos.
Identifier	String	Sí	PowerOff	El identificador del evento que desea consultar. Si se aplica verificación de bajo nivel, siga estos pasos para consultar el Identifier de un evento de dispositivo: inicie sesión en la consola de IoT Platform y vaya a la pestaña Define Feature de la página Product Details. También puede llamar a la operación QueryThingModel y consultar el identificador del servicio en los datos TSL devueltos. Si no se aplica ninguna verificación, el valor debe ser igual al valor del identificador personalizado enviado por el dispositivo.
PageSize	Integer	Sí	10	El número de entradas que se devolverán en cada página. Valores válidos: de 1 a 50. Valor predeterminado: 10.
StartTime	Long	Sí	1516538300303	El inicio del intervalo de tiempo que se va a consultar. El valor es una marca de tiempo de 13 dígitos en milisegundos.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	El ID de la instancia. Puede consultar el ID de la instancia en la página Overview de la consola de IoT Platform. Importante Si su instancia tiene un ID, configure este parámetro. Si no establece este parámetro, la llamada fallará. Si su instancia no tiene página de Overview ni ID, no necesita establecer este parámetro. Para obtener más información, consulte Descripción general.
ProductKey	String	No	a1BwAGV****	La clave ProductKey del producto al que pertenece el dispositivo. Nota Si especifica este parámetro, también debe especificar el parámetro DeviceName.
DeviceName	String	No	light	El nombre del dispositivo. Nota Si especifica este parámetro, también debe especificar el parámetro ProductKey.
NextPageToken	String	No	Bo***x44Qx	El identificador de la siguiente página. Si existe una página siguiente, se devuelve este parámetro. En ese caso, agregue el valor del parámetro a la siguiente solicitud.
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	El ID del dispositivo. Es el identificador único que IoT Platform generó para el dispositivo. Nota Si especifica este parámetro, no necesita especificar el parámetro ProductKey ni DeviceName. El parámetro IotId especifica un identificador único para el dispositivo y corresponde a una combinación de los parámetros ProductKey y DeviceName. Si especifica el parámetro IotId y la combinación de los parámetros ProductKey y DeviceName al mismo tiempo, solo se utilizará el parámetro IotId.

Además de los parámetros de solicitud específicos de la operación anteriores, debe especificar parámetros de solicitud comunes al llamar a esta operación de API. Para obtener más información sobre los parámetros de solicitud comunes, consulte Parámetros comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.device.InvalidIoTId	El código de error devuelto si la llamada falla. Para obtener más información, consulte Códigos de error.
Data	Struct		Los registros de eventos devueltos si la llamada se realiza correctamente.
List	Array of EventInfo		La matriz de eventos. Cada elemento representa un evento. Para obtener más información sobre los detalles del evento, consulte los parámetros de EventInfo.
EventInfo
EventType	String	info	El tipo de evento. Valores válidos: info: información. alert: alerta. error: error.
Identifier	String	PowerOff	El identificador del evento.
Name	String	Device shutdown	El nombre del evento.
OutputData	String	{"structArgs":{"structchildFLOATf71c20e":1.23}}	El parámetro de salida del evento. El valor es una cadena con formato MAP.
Time	String	1579163099000	La hora en que ocurrió el evento. El valor es una marca de tiempo de 13 dígitos en milisegundos.
NextPageToken	String	Bo***x44Qx	El identificador de la siguiente página.
NextValid	Boolean	true	Indica si existe una página siguiente. true: Existe una página siguiente. false: No existe una página siguiente. Si se devuelve el valor true, agregue el valor del parámetro NextPageToken a la siguiente solicitud. Esto le permite consultar los datos que no se incluyeron en la consulta actual.
ErrorMessage	String	A system exception has occurred.	El mensaje de error devuelto si la llamada falla.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	El ID de la solicitud.
Success	Boolean	true	Indica si la llamada se realizó correctamente. true: La llamada se realizó correctamente. false: La llamada falló.

Ejemplos

Solicitudes de ejemplo

http(s)://iot.cn-shanghai.aliyuncs.com/? Action=QueryDeviceOriginalEventData
&Asc=0
&EndTime=1516541900303
&Identifier=PowerOff
&PageSize=10
&StartTime=1516538300303
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato 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>

Formato 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
}

Códigos de error

Para obtener una lista de códigos de error, visite el Centro de errores de API.