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

Consulta os registros de eventos enviados por um dispositivo específico. Esses registros incluem eventos validados e não validados por um modelo TSL (Thing Specification Language) definido.

Limites

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

Nota

O período de retenção de um registro de evento é contado a partir do dia em que o registro foi gerado.

Cada conta Alibaba Cloud pode executar no máximo 50 consultas por segundo (QPS).

Nota
Os usuários do Resource Access Management (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 da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	QueryDeviceOriginalEventData	Operação a ser executada. Defina o valor como QueryDeviceOriginalEventData.
Asc	Integer	Sim	0	Ordem de classificação dos registros de eventos retornados. Valores válidos: 0: decrescente. 1: crescente.
EndTime	Long	Sim	1516541900303	Fim do intervalo de tempo a ser consultado. O valor é um timestamp de 13 dígitos em milissegundos.
Identifier	String	Sim	PowerOff	Identificador do evento a ser consultado. Se a validação de baixo nível estiver aplicada, siga estas etapas para visualizar o Identifier de um evento de dispositivo: faça login no console do IoT Platform e acesse a aba Define Feature na página Product Details. Alternativamente, chame a operação QueryThingModel e verifique o identificador do serviço nos dados TSL retornados. Caso nenhuma validação esteja aplicada, o valor deve corresponder ao identificador personalizado enviado pelo dispositivo.
PageSize	Integer	Sim	10	Número de entradas a serem retornadas em cada página. Valores válidos: 1 a 50. Valor padrão: 10.
StartTime	Long	Sim	1516538300303	Início do intervalo de tempo a ser consultado. O valor é um timestamp de 13 dígitos em milissegundos.
IotInstanceId	String	Não	iot_instc_pu***_c-v64********	ID da instância. Visualize o ID da instância na página Overview no console do IoT Platform. Importante Configure este parâmetro se sua instância possuir um ID. A chamada falhará caso este parâmetro não seja definido. Não é necessário definir este parâmetro se sua instância não tiver uma página Overview ou ID. Para mais informações, consulte Overview.
ProductKey	String	Não	a1BwAGV****	A ProductKey do produto ao qual o dispositivo pertence. Nota Ao especificar este parâmetro, também especifique o parâmetro DeviceName.
DeviceName	String	Não	light	Nome do dispositivo. Nota Ao especificar este parâmetro, também especifique o parâmetro ProductKey.
NextPageToken	String	Não	Bo***x44Qx	Identificador da próxima página. Este parâmetro é retornado quando existe uma próxima página. Nesse caso, adicione o valor do parâmetro à próxima solicitação.
IotId	String	Não	Q7uOhVRdZRRlDnTLv****00100	ID do dispositivo. Trata-se do identificador exclusivo que o IoT Platform gerou para o dispositivo. Nota Não é necessário especificar os parâmetros ProductKey ou DeviceName ao especificar este parâmetro. O parâmetro IotId define um identificador exclusivo para o dispositivo e corresponde à combinação dos parâmetros ProductKey e DeviceName. Se você especificar o parâmetro IotId e a combinação dos parâmetros ProductKey e DeviceName simultaneamente, apenas o parâmetro IotId será utilizado.

Além dos parâmetros de solicitação específicos da operação anteriores, especifique parâmetros de solicitação comuns ao chamar esta operação de API. Para obter mais informações sobre parâmetros de solicitação comuns, consulte Parâmetros comuns.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
Code	String	iot.device.InvalidIoTId	Código de erro retornado se a chamada falhar. Para mais informações, consulte Códigos de erro.
Data	Struct		Registros de eventos retornados se a chamada for bem-sucedida.
List	Array of EventInfo		Array de eventos. Cada elemento representa um evento. Para obter detalhes sobre o evento, consulte os parâmetros de EventInfo.
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	{"structArgs":{"structchildFLOATf71c20e":1.23}}	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 de 13 dígitos em milissegundos.
NextPageToken	String	Bo***x44Qx	Identificador da próxima página.
NextValid	Boolean	true	Indica se existe uma próxima página. true: Existe uma próxima página. false: Não existe uma próxima página. Se o valor true for retornado, adicione o valor do parâmetro NextPageToken à próxima solicitação. Isso permite consultar os dados não incluídos na consulta atual.
ErrorMessage	String	A system exception has occurred.	Mensagem de erro retornada se a chamada falhar.
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

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

Exemplos de respostas de sucesso

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 erro

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