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

Limites

Cada conta Alibaba Cloud aceita no máximo 500 consultas por segundo (QPS).

Nota

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

Depuração

A Alibaba Cloud oferece o OpenAPI Explorer para simplificar o uso da API. 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

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	QueryDeviceInfo	Operação a ser executada. Defina o valor como QueryDeviceInfo.
IotInstanceId	String	Não	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 página Overview ou ID, não defina este parâmetro. Para mais informações, consulte Visão geral.
ProductKey	String	Não	a1BwAGV****	ProductKey do produto ao qual o dispositivo pertence. Importante Ao especificar este parâmetro, especifique também o parâmetro DeviceName.
DeviceName	String	Não	light	DeviceName do dispositivo. Importante Ao especificar este parâmetro, especifique também o parâmetro ProductKey.
IotId	String	Não	Q7uOhVRdZRRlDnTLv****00100	ID do dispositivo. Importante Se você especificar este parâmetro, não será necessário informar ProductKey ou DeviceName. O parâmetro IotId é o identificador globalmente exclusivo (GUID) do dispositivo e corresponde à combinação de ProductKey e DeviceName. Se forem fornecidos tanto o IotId quanto a combinação de ProductKey e DeviceName, o IotId terá precedência.

Além dos parâmetros específicos listados acima, especifique os parâmetros comuns de solicitação ao chamar esta operação. 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	Código de erro retornado se a chamada falhar. Para mais informações, consulte Códigos de erro.
Data	Struct		Informações do dispositivo retornadas se a chamada for bem-sucedida.
DeviceName	String	light	DeviceName do dispositivo.
DeviceSecret	String	mz2Canp4GB7qRVf1OYPNtRqB2anu****	DeviceSecret do dispositivo.
IotId	String	Q7uOhVRdZRRlDnTLv****00100	ID do dispositivo. Identificador exclusivo emitido pelo IoT Platform.
Nickname	String	detectors_in_beijing	Alias do dispositivo.
ProductKey	String	a1rYuVF****	ProductKey do produto ao qual o dispositivo pertence.
ErrorMessage	String	A system exception 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: Chamada bem-sucedida. false: Falha na chamada.

Exemplos

Exemplos de solicitações

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceInfo
&ProductKey=a1rYuVF****
&DeviceName=light
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

<QueryDeviceInfoResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <IotId>Q7uOhVRdZRRlDnTLv****00100</IotId>
        <DeviceSecret>mz2Canp4GB7qRVf1OYPNtRqB2anu****</DeviceSecret>
        <ProductKey>a1rYuVF****</ProductKey>
        <Nickname>detectors_in_beijing</Nickname>
        <DeviceName>light</DeviceName>
  </Data>
  <Success>true</Success>
</QueryDeviceInfoResponse>

Formato JSON

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "IotId": "Q7uOhVRdZRRlDnTLv****00100",
        "DeviceSecret": "mz2Canp4GB7qRVf1OYPNtRqB2anu****",
        "ProductKey": "a1rYuVF****",
        "Nickname": "detectors_in_beijing",
        "DeviceName": "light"
    },
    "Success": true
}

Códigos de erro

HttpCode	Código de erro	Mensagem de erro	Descrição
200	Iot.common.QueryDeviceActionError	An error occurred while querying the device.	Mensagem retornada quando o sistema falha ao consultar as informações do dispositivo.

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