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

Consulta los registros de eventos de un dispositivo específico.

Notas de uso

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.

Límites de QPS

Cada cuenta de Alibaba Cloud admite hasta 50 consultas por segundo (QPS).

Nota

Los usuarios 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 from 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í	QueryDeviceEventData	La operación que desea ejecutar. Establezca el valor en QueryDeviceEventData.
EndTime	Long	Sí	1516541900303	El final del intervalo de tiempo a consultar. El valor es una marca de tiempo de 13 dígitos en milisegundos. Ejemplo: 1516541900303.
StartTime	Long	Sí	1516541900303	El inicio del intervalo de tiempo a consultar. El valor es una marca de tiempo de 13 dígitos en milisegundos. Ejemplo: 1516538300303. Nota Solo se pueden consultar los datos de eventos de los últimos 30 días.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	El ID de la instancia. Consulte el ID de la instancia en la página Overview de la consola de IoT Platform. Importante Si su instancia tiene un ID, debe especificar este parámetro. De lo contrario, la llamada fallará. Si la página Overview no aparece en la consola de IoT Platform o no se ha generado un ID para su instancia, no es necesario especificar este parámetro. Para obtener más información, consulte Descripción general.
PageSize	Integer	No	10	El número de entradas a devolver en cada página. Valores válidos: de 1 a 50. Valor predeterminado: 10.
ProductKey	String	No	a1BwAGV****	La 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 DeviceName del dispositivo. Nota Si especifica un valor para este parámetro, también debe especificar un valor para el parámetro ProductKey.
Identifier	String	No	PowerOff	El identificador del evento a consultar. Consulte el identificador del evento en la pestaña Define Feature de la página Product Details en la consola de IoT Platform. También puede llamar a la operación QueryThingModel y ver el identificador del evento en los datos TSL devueltos. Nota Si el evento PowerOff pertenece a un módulo personalizado llamado testFb, este parámetro se establece en testFb:PowerOff. Si no especifica este parámetro, el sistema consulta todos los datos de eventos del módulo predeterminado.
EventType	String	No	info	El tipo de evento a consultar. Valores válidos: info: Información. alert: Alerta. error: Error.
Asc	Integer	No	0	El orden de clasificación de los registros de eventos devueltos. Valores válidos: 0: en orden cronológico inverso. Este es el valor predeterminado. 1: en orden cronológico. Nota Si no configura este parámetro, se utiliza el valor predeterminado 0. El sistema clasifica los registros de eventos devueltos en orden cronológico inverso.
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	El ID del dispositivo. Es un identificador único que IoT Platform asigna al dispositivo. Nota Si especifica un valor para este parámetro, no necesita especificar un valor para el parámetro ProductKey o DeviceName. El parámetro IotId especifica un identificador único global (GUID) para el dispositivo. El valor del parámetro IotId corresponde a una combinación de los valores de los parámetros ProductKey y DeviceName. Si especifica un valor para el parámetro IotId y valores para los parámetros ProductKey y DeviceName, el valor del parámetro IotId tiene prioridad.

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

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	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.
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	null	El parámetro de salida del evento. El valor es una cadena en formato MAP.
Time	String	1579163099000	La hora en que ocurrió el evento. El valor es una marca de tiempo en milisegundos.
NextTime	Long	1579163099000	La hora de inicio de los registros de eventos en la siguiente página. El valor es una marca de tiempo en milisegundos. Si el parámetro Asc está establecido en 0, especifique este valor para el parámetro EndTime cuando vuelva a llamar a esta operación para consultar la siguiente página de registros de eventos. Si el parámetro Asc está establecido en 1, especifique este valor para el parámetro StartTime cuando vuelva a llamar a esta operación para consultar la siguiente página de registros de eventos.
NextValid	Boolean	true	Indica si existe la siguiente página. true: La siguiente página existe. Se devuelve el valor del parámetro NextTime. Para obtener más información, consulte la descripción del parámetro NextTime en este tema. false: La siguiente página no existe.
ErrorMessage	String	A system exception 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

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
&<Common request parameters>

Respuestas exitosas de ejemplo

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

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

Códigos de error

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