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

Observações de uso

Não é possível consultar os valores desejados de propriedades somente leitura.
Consulte os valores desejados de até 10 propriedades em uma única chamada.

Limites de QPS

Cada conta pode chamar esta API até 50 vezes por segundo.

Nota

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

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos que você chame 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	QueryDeviceDesiredProperty	A operação a ser executada. Defina o valor como QueryDeviceDesiredProperty.
IotInstanceId	String	Não	iot_instc_pu***_c-v64********	O ID da instância. Visualize o ID da instância na página Overview no console do IoT Platform. Importante Se sua instância tiver um ID, especifique-o neste parâmetro. Caso contrário, a chamada falhará. Se não houver uma página Overview ou ID gerado para sua instância, não configure este parâmetro. Para mais informações, consulte Visão geral.
ProductKey	String	Não	a1BwAGV****	A ProductKey do produto ao qual o dispositivo pertence. Nota Ao especificar um valor para este parâmetro, configure também o parâmetro DeviceName.
DeviceName	String	Não	light	O DeviceName do dispositivo. Nota Ao especificar um valor para este parâmetro, configure também o parâmetro ProductKey.
Identifier.N	RepeatList	Não	Temperature	Os identificadores das propriedades a serem consultadas. Para visualizar os identificadores de propriedade, acesse a aba Define Feature da página Product Details no console do IoT Platform. Especifique até 10 identificadores de propriedade em uma única chamada. Cada identificador de propriedade deve ser único. Sem a configuração deste parâmetro, o sistema retorna os valores desejados de todas as propriedades.
IotId	String	Não	Q7uOhVRdZRRlDnTLv****00100	O ID do dispositivo. Trata-se de um identificador exclusivo emitido pelo IoT Platform para o dispositivo. Nota Ao especificar um valor para este parâmetro, não configure os parâmetros ProductKey ou DeviceName. O parâmetro IotId define um GUID para o dispositivo. O valor do parâmetro IotId equivale à combinação dos valores dos parâmetros ProductKey e DeviceName. Se forem especificados valores para os parâmetros IotId, ProductKey e DeviceName, o valor do parâmetro IotId terá precedência.
FunctionBlockId	String	Não	BatteryModule	O identificador do módulo TSL personalizado. Cada identificador é exclusivo dentro de um produto. Sem a configuração deste parâmetro, o sistema consulta os dados do módulo padrão.

Além dos parâmetros de solicitação específicos da operação mencionados acima, configure os parâmetros de solicitação comuns ao chamar esta operação. Para 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.system.SystemException	O código de erro retornado se a chamada falhar. Para mais informações, consulte Códigos de erro.
Data	Struct		Os dados retornados no parâmetro List se a chamada for bem-sucedida.
List	Array of DesiredPropertyInfo		As informações de propriedade desejada retornadas no parâmetro DesiredPropertyInfo.
DesiredPropertyInfo
DataType	String	int	O tipo de dados da propriedade.
Identifier	String	Temperature	O identificador da propriedade.
Name	String	airconditioning	O nome da propriedade.
Time	String	1579335899000	A hora da última modificação do valor desejado da propriedade. Unidade: milissegundos.
Unit	String	°C	A unidade da propriedade.
Value	String	34	O valor desejado da propriedade. Nota Se você chamar a operação ClearDeviceDesiredProperty para excluir o valor desejado da propriedade, o parâmetro Value não será retornado.
Version	Long	1	A versão do valor desejado.
ErrorMessage	String	A system exception occurred.	A mensagem de erro retornada se a chamada falhar.
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=QueryDeviceDesiredProperty
&IotId=SR8FiTu1R9tlUR2****0010300
&Identifier.1=Weight
&Identifier.2=Circle
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

<QueryDeviceDesiredPropertyResponse>
  <Data>
        <List>
              <DesiredPropertyInfo>
                    <Name>Temperature</Name>
                    <Value>35</Value>
                    <Time>1581778567154</Time>
                    <DataType>float</DataType>
                    <Version>1</Version>
                    <Identifier>Temperature</Identifier>
                    <Unit>°C</Unit>
              </DesiredPropertyInfo>
        </List>
  </Data>
  <RequestId>F0B1F7C8-A799-44C3-BDF8-1B8F9E91E675</RequestId>
  <Success>true</Success>
</QueryDeviceDesiredPropertyResponse>

Formato JSON

{
  "Data": {
    "List": {
      "DesiredPropertyInfo": [
        {
          "Name": "Temperature", 
          "Value": "35", 
          "Time": "1581778567154", 
          "DataType": "float", 
          "Version": 1, 
          "Identifier": "Temperature", 
          "Unit": "°C"
        }
      ]
    }
  }, 
  "RequestId": "F0B1F7C8-A799-44C3-BDF8-1B8F9E91E675", 
  "Success": true
}

Códigos de erro

Para obter uma lista de códigos de erro, consulte os códigos de erro do Serviço.