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

Consulta as tags de um dispositivo.

Limites

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

Nota

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

Depuração

A Alibaba Cloud oferece o OpenAPI Explorer para simplificar o uso de APIs. O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer, que também gera dinamicamente códigos de exemplo para diferentes SDKs.

Parâmetros da solicitação

Parameter	Type	Required	Example	Description
Action	String	Yes	QueryDeviceProp	Operação a ser executada. Defina o valor como QueryDeviceProp.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	ID da instância. Visualize o ID da instância na página Overview do console IoT Platform. Importante Se a instância tiver um ID, configure este parâmetro. Caso contrário, a chamada falhará. Se a instância não tiver uma página Overview ou ID, não é necessário definir este parâmetro. Para mais informações, consulte Visão geral.
ProductKey	String	No	a1BwAGV****	ProductKey do produto ao qual o dispositivo pertence. Nota Ao especificar este parâmetro, especifique também o parâmetro DeviceName.
DeviceName	String	No	light	DeviceName do dispositivo. Nota Ao especificar este parâmetro, especifique também o parâmetro ProductKey.
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	ID do dispositivo emitido pelo IoT Platform. Nota Ao usar este parâmetro, não é necessário especificar ProductKey ou DeviceName. O parâmetro IotId representa um identificador globalmente único (GUID) do dispositivo, correspondente à combinação de ProductKey e DeviceName. Se você especificar tanto o IotId quanto a combinação de ProductKey e DeviceName, o IotId terá precedência.

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

Parâmetros de resposta

Parameter	Type	Example	Description
Code	String	iot.system.SystemException	Código de erro retornado se a chamada falhar. Para mais informações, consulte Códigos de erro.
ErrorMessage	String	A system exception occurred.	Mensagem de erro retornada se a chamada falhar.
Props	String	{\"coordinate\":\"104.07086:30.549169\"}	String JSON retornada se a chamada for bem-sucedida. A string contém os detalhes das tags do dispositivo.
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=QueryDeviceProp
&ProductKey=a1BwAGV****
&DeviceName=device1
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

<QueryDevicePropResponse>
  <RequestId>D8CEF5E7-1484-4164-A242-C06BA3A54E0F</RequestId>
  <Props>{"coordinate":"104.07086:30.549169"}</Props>
  <Success>true</Success>
</QueryDevicePropResponse>

Formato JSON

{
    "RequestId": "D8CEF5E7-1484-4164-A242-C06BA3A54E0F",
    "Props": "{\"coordinate\":\"104.07086:30.549169\"}",
    "Success": true
}

Códigos de erro

Para obter uma lista de códigos de erro, visite o Centro de Erros de API.