QueryDeviceEventData - IoT Platform: Central de Documentação do Alibaba Cloud

Consulta os registros de eventos de um dispositivo especificado.

Observações de uso

É possível consultar apenas os registros de eventos gerados nos últimos 30 dias.

Nota

O período de armazenamento de um registro de evento é calculado a partir do dia em que o registro é gerado.

Limites de QPS

Cada conta Alibaba Cloud pode executar até 50 consultas por segundo (QPS).

Nota

Os usuários RAM de uma conta Alibaba Cloud compartilham a cota dessa conta.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parameter	Type	Required	Example	Description
Action	String	Yes	QueryDeviceEventData	A operação a ser executada. Defina o valor como QueryDeviceEventData.
EndTime	Long	Yes	1516541900303	Fim do intervalo de tempo a ser consultado. O valor é um timestamp de 13 dígitos em milissegundos. Exemplo: 1516541900303.
StartTime	Long	Yes	1516541900303	Início do intervalo de tempo a ser consultado. O valor é um timestamp de 13 dígitos em milissegundos. Exemplo: 1516538300303. Nota É possível consultar dados de eventos apenas dos últimos 30 dias.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	ID da instância. Visualize o ID da instância na página Overview no console IoT Platform. Importante Se sua instância possuir um ID, especifique este parâmetro. Caso contrário, a chamada falhará. Se a página Overview não aparecer no console IoT Platform ou se nenhum ID for gerado para sua instância, não é necessário especificar este parâmetro. Para mais informações, consulte Visão geral.
PageSize	Integer	No	10	Número de entradas a serem retornadas em cada página. Valores válidos: 1 a 50. Valor padrão: 10.
ProductKey	String	No	a1BwAGV****	ProductKey do produto ao qual o dispositivo pertence. Nota Ao especificar este parâmetro, também é obrigatório especificar o parâmetro DeviceName.
DeviceName	String	No	light	DeviceName do dispositivo. Nota Caso defina um valor para este parâmetro, você deve igualmente definir um valor para o parâmetro ProductKey.
Identifier	String	No	PowerOff	Identificador do evento a ser consultado. Verifique o identificador do evento na aba Define Feature da página Product Details no console IoT Platform. Alternativamente, chame a operação QueryThingModel e visualize o identificador do evento nos dados TSL retornados. Nota Se o evento PowerOff pertencer a um módulo personalizado chamado testFb, este parâmetro será definido como testFb:PowerOff. Sem a especificação deste parâmetro, o sistema consulta todos os dados de eventos do módulo padrão.
EventType	String	No	info	Tipo do evento a ser consultado. Valores válidos: info: Informação. alert: Alerta. error: Erro.
Asc	Integer	No	0	Ordem de classificação dos registros de eventos retornados. Valores válidos: 0: ordem cronológica inversa. Este é o valor padrão. 1: ordem cronológica. Nota Se você não configurar este parâmetro, o valor padrão 0 será utilizado. O sistema classificará os registros de eventos retornados em ordem cronológica inversa.
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	ID do dispositivo. Trata-se de um identificador exclusivo emitido pelo IoT Platform para o dispositivo. Nota Ao informar um valor para este parâmetro, não é necessário informar valores para os parâmetros ProductKey ou DeviceName. O parâmetro IotId define um identificador globalmente único (GUID) para o dispositivo. O valor do parâmetro IotId corresponde a uma combinação dos valores dos parâmetros ProductKey e DeviceName. Se forem especificados valores tanto para o parâmetro IotId quanto para os parâmetros ProductKey e DeviceName, o valor do parâmetro IotId terá precedência.

Além dos parâmetros de solicitação específicos da operação mencionados acima, é necessário especificar parâmetros de solicitação comuns ao chamar esta operação. Para mais informações, consulte Parâmetros de solicitação comuns.

Parâmetros de resposta

Parameter	Type	Example	Description
Code	String	iot.system.SystemException	Código de erro retornado caso a chamada falhe. Para mais informações, consulte Códigos de erro.
Data	Struct		Registros de eventos retornados em caso de sucesso na chamada.
List	Array of EventInfo		Array de eventos. Cada elemento representa um evento.
EventInfo
EventType	String	info	Tipo do evento. Valores válidos: info: informação. alert: alerta. error: erro.
Identifier	String	PowerOff	Identificador do evento.
Name	String	Device shutdown	Nome do evento.
OutputData	String	null	Parâmetro de saída do evento. O valor é uma string no formato MAP.
Time	String	1579163099000	Momento em que o evento ocorreu. O valor é um timestamp em milissegundos.
NextTime	Long	1579163099000	Hora inicial dos registros de eventos na próxima página. O valor é um timestamp em milissegundos. Quando o parâmetro Asc estiver definido como 0, utilize este valor no parâmetro EndTime ao chamar esta operação novamente para consultar a próxima página de registros de eventos. Quando o parâmetro Asc estiver definido como 1, utilize este valor no parâmetro StartTime ao chamar esta operação novamente para consultar a próxima página de registros de eventos.
NextValid	Boolean	true	Indica se existe uma próxima página. true: A próxima página existe. O valor do parâmetro NextTime é retornado. Para mais detalhes, veja a descrição do parâmetro NextTime neste tópico. false: Não existe próxima página.
ErrorMessage	String	A system exception occurred.	Mensagem de erro retornada caso a chamada falhe.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	ID da solicitação.
Success	Boolean	true	Indica se a chamada foi bem-sucedida. true: A chamada foi bem-sucedida. false: A chamada falhou.

Exemplos

Exemplos de solicitações

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>

Exemplos de respostas de sucesso

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 erro

Para obter uma lista de códigos de erro, visite o API Error Center.