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

Limites de QPS

Cada conta Alibaba Cloud pode executar 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. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	QueryDeviceDetail	Operação a ser executada. Defina o valor como QueryDeviceDetail.
IotInstanceId	String	Não	iot-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, especifique-o neste parâmetro. Caso contrário, a chamada falhará. Se não houver página Overview ou ID gerado para a instância, não configure este parâmetro. Para mais informações, consulte Visão geral.
ProductKey	String	Não	a1BwAGV****	ProductKey do produto ao qual o dispositivo pertence. Nota Ao especificar um valor para este parâmetro, também especifique um valor para o parâmetro DeviceName.
DeviceName	String	Não	light	DeviceName do dispositivo. Nota Ao especificar um valor para este parâmetro, também especifique um valor para o parâmetro ProductKey.
IotId	String	Não	Q7uOhVRdZRRlDnTLv****00100	ID do dispositivo. Nota 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 exclusivo (GUID) para o dispositivo e corresponde à combinação dos valores de ProductKey e DeviceName. Se você informar IotId juntamente com ProductKey e DeviceName, o valor de IotId terá precedência.

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

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		Detalhes do dispositivo retornados em caso de sucesso na chamada.
DeviceName	String	light	DeviceName do dispositivo.
DeviceSecret	String	mz2Canp4GB7qRVf1OYPNtRqB2anu****	DeviceSecret do dispositivo.
FirmwareVersion	String	V1.0.0.0	Versão do módulo OTA padrão do dispositivo. Para consultar versões de outros módulos OTA, chame a operação ListOTAModuleVersionsByDevice. O dispositivo envia essas informações de versão.
GmtActive	String	2018-08-06 10:48:41	Horário de ativação do dispositivo no formato GMT.
GmtCreate	String	2018-08-06 10:47:50	Horário de criação do dispositivo no formato GMT.
GmtOnline	String	2018-08-06 13:43:12	Último horário em que o dispositivo esteve online no formato GMT.
IotId	String	Q7uOhVRdZRRlDnTLv****00100	ID do dispositivo. Identificador exclusivo emitido pelo IoT Platform.
IpAddress	String	10.0.0.1	Endereço IP do dispositivo.
Nickname	String	detectors_in_beijing	Alias do dispositivo.
NodeType	Integer	0	Tipo de nó. Valores válidos: 0: dispositivo. Não aceita subdispositivos anexados. Conecta-se ao IoT Platform diretamente ou como subdispositivo de um gateway. 1: gateway. Aceita subdispositivos anexados. Gerencia subdispositivos, mantém relacionamentos topológicos e os sincroniza com o IoT Platform.
Owner	Boolean	true	Indica se o proprietário do dispositivo realizou a chamada da operação.
ProductKey	String	a1rYuVF****	ProductKey do produto ao qual o dispositivo pertence.
ProductName	String	test	Nome do produto ao qual o dispositivo pertence.
Region	String	cn-shanghai	ID da região onde o dispositivo está localizado. Corresponde à região do IoT Platform. Visualize a região no console IoT Platform.
Status	String	ONLINE	Status do dispositivo. Valores válidos: ONLINE: dispositivo online. OFFLINE: dispositivo offline. UNACTIVE: dispositivo não ativado. DISABLE: dispositivo desabilitado.
UtcActive	String	2018-08-06T02:48:41.000Z	Horário de ativação do dispositivo no formato UTC.
UtcCreate	String	2018-08-06T02:47:50.000Z	Horário de criação do dispositivo no formato UTC.
UtcOnline	String	2018-08-06T05:43:12.000Z	Último horário em que o dispositivo esteve online no formato UTC.
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

Solicitações de exemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceDetail
&ProductKey=a1rYuVF****
&DeviceName=device1
&<Common request parameters>

Respostas de sucesso de exemplo

Formato XML

<QueryDeviceDetailResponse>
  <Data>
        <Owner>true</Owner>
        <GmtActive>2020-01-16 13:33:37</GmtActive>
        <DeviceName>Humidity</DeviceName>
        <ProductKey>a1ttsqu****</ProductKey>
        <DeviceSecret>sLefbFmN9SYfnWLJTePG893XNuRV****</DeviceSecret>
        <IpAddress>42.120.75.144</IpAddress>
        <GmtCreate>2020-01-08 14:47:08</GmtCreate>
        <UtcCreate>2020-01-08T06:47:08.000Z</UtcCreate>
        <IotId>dwnS41bhNxjslDAIF****00100</IotId>
        <Status>OFFLINE</Status>
        <UtcOnline>2020-01-17T08:19:11.091Z</UtcOnline>
        <Region>cn-shanghai</Region>
        <UtcActive>2020-01-16T05:33:37.830Z</UtcActive>
        <Nickname>Temperature and humidity</Nickname>
        <NodeType>0</NodeType>
        <GmtOnline>2020-01-17 16:19:11</GmtOnline>
        <ProductName>Light, temperature, and humidity sensor
  </Data>
  <RequestId>D2D2DE90-DD0F-44EA-9F56-63F07A59F65B</RequestId>
  <Success>true</Success>
</QueryDeviceDetailResponse>

Formato JSON

{
	"Data": {
		"Owner": true,
		"GmtActive": "2020-01-16 13:33:37",
		"DeviceName": "Humidity",
		"ProductKey": "a1ttsqu****",
		"DeviceSecret": "sLefbFmN9SYfnWLJTePG893XNuRV****",
		"IpAddress": "42.120.75.144",
		"GmtCreate": "2020-01-08 14:47:08",
		"UtcCreate": "2020-01-08T06:47:08.000Z",
		"IotId": "dwnS41bhNxjslDAIF****00100",
		"Status": "OFFLINE",
		"UtcOnline": "2020-01-17T08:19:11.091Z",
		"Region": "cn-shanghai",
		"UtcActive": "2020-01-16T05:33:37.830Z",
		"NickName": "Temperature and humidity",
		"NodeType": 0,
		"GmtOnline": "2020-01-17 16:19:11",
		"ProductName": "Light, temperature, and humidity sensor"
	},
	"RequestId": "D2D2DE90-DD0F-44EA-9F56-63F07A59F65B",
	"Success": true
}

Códigos de erro

Para obter uma lista de códigos de erro, visite a Central de Erros de API.