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

Observações de uso

Se um dispositivo ou nó de gêmeo digital tiver várias propriedades, chame esta operação várias vezes para consultar os dados de cada propriedade. Especifique um valor para o parâmetro Identifier em cada chamada. Como alternativa, use a operação QueryDevicePropertiesData e especifique vários valores para o parâmetro Identifier para consultar os dados das propriedades simultaneamente.

Limites

É possível consultar apenas dados de propriedades gerados nos últimos 30 dias.

Nota

Os dados de uma propriedade são armazenados a partir do dia em que são gerados.

Limites de QPS

Cada conta Alibaba Cloud permite 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 maior comodidade, 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	QueryDevicePropertyData	A operação a ser executada. Defina o valor como QueryDevicePropertyData.
EndTime	Long	Sim	1579249499000	O fim do intervalo de tempo da consulta. O valor do parâmetro EndTime deve ser maior que o valor do parâmetro StartTime. Este valor é um timestamp em milissegundos, por exemplo, 1579249499000.
Asc	Integer	Sim	0	A ordem de classificação dos registros de propriedade retornados. Valores válidos: 0: ordem cronológica inversa 1: ordem cronológica
Identifier	String	Sim	temperature	O identificador da propriedade a ser consultada. Visualize o identificador da propriedade na aba Define Feature da página Product Details no console IoT Platform. Também é possível chamar a operação QueryThingModel e verificar o identificador da propriedade nos dados TSL retornados. Nota Se uma propriedade chamada temperature pertencer a um módulo personalizado chamado testFb, defina este parâmetro como testFb:temperature. O módulo personalizado não é o módulo padrão.
PageSize	Integer	Sim	10	Número de entradas a retornar em cada página. Valores válidos: 1 a 50.
StartTime	Long	Sim	1579249499000	O início do intervalo de tempo da consulta. O valor do parâmetro StartTime deve ser menor que o valor do parâmetro EndTime. Este valor é um timestamp em milissegundos, por exemplo, 1579249499000.
IotInstanceId	String	Não	iot-cn-0pp1n8t****	O ID da instância. Visualize o ID da instância na página Overview no console IoT Platform. Importante Configure este parâmetro caso sua instância possua um ID. A chamada falhará se este parâmetro não for configurado. Não é necessário configurar este parâmetro se sua instância não tiver uma página Overview ou ID. Para mais informações, consulte Overview.
IotId	String	Não	Q7uOhVRdZRRlDnTLv****00100	O ID do dispositivo ao qual a propriedade pertence.: Chame a operação QueryDeviceInfo para consultar o ID do dispositivo. Importante Ao especificar um valor para este parâmetro, não é necessário informar os parâmetros ProductKey ou DeviceName. O parâmetro IotId define um identificador globalmente único (GUID) para o dispositivo. Seu valor corresponde à combinação dos valores dos parâmetros ProductKey e DeviceName. Caso informe tanto o IotId quanto o ProductKey e o DeviceName, o valor de IotId terá precedência.
ProductKey	String	Não	a1BwAGV****	A ProductKey do produto ao qual o dispositivo pertence. Importante É obrigatório especificar também o parâmetro DeviceName ao definir este parâmetro.
DeviceName	String	Não	airconditioning	O nome do dispositivo. Importante É obrigatório especificar também o parâmetro ProductKey ao definir este parâmetro.

Além dos parâmetros específicos desta operação, especifique os parâmetros comuns de solicitação ao chamar esta API. Para mais detalhes, consulte Parâmetros comuns de solicitação.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
Code	String	iot.system.SystemException	O código de erro retornado em caso de falha na chamada. Para mais informações, consulte Códigos de erro.
Data	Struct		Os dados da propriedade retornados quando a chamada é bem-sucedida.
List	Array of PropertyInfo		A lista de registros de propriedade.
PropertyInfo
Time	String	1516541885630	O momento em que a propriedade foi modificada.
Value	String	2	O valor da propriedade.
NextTime	Long	1579249499000	O horário inicial dos registros de propriedade na próxima página. Quando o parâmetro Asc estiver definido como 0, utilize este valor no parâmetro EndTime na próxima chamada para obter a página seguinte de registros. Quando o parâmetro Asc estiver definido como 1, utilize este valor no parâmetro StartTime na próxima chamada para obter a página seguinte de registros.
NextValid	Boolean	true	Indica se existe uma próxima página. true: Existe uma próxima página. Se NextValid retornar true, o valor do parâmetro NextTime será incluído na resposta. Consulte a descrição do parâmetro NextTime neste tópico para mais detalhes. false: Não existe próxima página.
ErrorMessage	String	A system exception occurred.	A mensagem de erro retornada em caso de falha na chamada.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	O 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=QueryDevicePropertyData
&ProductKey=a1BwAGV****
&DeviceName=device1
&Identifier=lightLevel
&StartTime=1516538300303
&EndTime=1516541900303
&PageSize=10
&Asc=1
&<Common request parameters>

Exemplos de respostas

Formato XML

<QueryDevicePropertyDataResponse>
  <Data>
        <NextValid>false</NextValid>
        <NextTime>1579249151177</NextTime>
        <List>
              <PropertyInfo>
                    <Value>32.46</Value>
                    <Time>1579249151178</Time>
              </PropertyInfo>
        </List>
  </Data>
  <RequestId>45391E10-446B-4986-863E-1BA8CC44748F</RequestId>
  <Success>true</Success>
</QueryDevicePropertyDataResponse>

Formato JSON

{
  "Data": {
    "NextValid": false, 
    "NextTime": 1579249151177, 
    "List": {
      "PropertyInfo": [
        {
          "Value": "32.46", 
          "Time": 1579249151178
        }
      ]
    }
  }, 
  "RequestId": "45391E10-446B-4986-863E-1BA8CC44748F", 
  "Success": true
}

Códigos de erro

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