QueryDeviceDetail - IoT Platform - Centro de documentación de Alibaba Cloud

Consulta los detalles de un dispositivo.

Límites de QPS

Cada cuenta de Alibaba Cloud admite hasta 50 consultas por segundo (QPS).

Nota

Los usuarios RAM de una cuenta de Alibaba Cloud comparten la cuota de dicha cuenta.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, se recomienda llamar a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	QueryDeviceDetail	La operación que desea ejecutar. Establezca el valor en QueryDeviceDetail.
IotInstanceId	String	No	iot-v64***	El ID de la instancia. Consulte el ID de la instancia en la página Overview de la consola de IoT Platform. Importante Si su instancia tiene un ID, especifíquelo en este parámetro. De lo contrario, la llamada fallará. Si no se genera ninguna página Overview o ID para su instancia, no es necesario configurar este parámetro. Para obtener más información, consulte Descripción general.
ProductKey	String	No	a1BwAGV****	La ProductKey del producto al que pertenece el dispositivo. Nota Si especifica un valor para este parámetro, también debe especificar un valor para el parámetro DeviceName.
DeviceName	String	No	light	El DeviceName del dispositivo. Nota Si especifica un valor para este parámetro, también debe especificar un valor para el parámetro ProductKey.
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	El ID del dispositivo. Nota Si especifica un valor para este parámetro, no es necesario especificar los parámetros ProductKey o DeviceName. El parámetro IotId actúa como identificador único global (GUID) del dispositivo y equivale a la combinación de ProductKey y DeviceName. Si especifica IotId junto con ProductKey y DeviceName, el valor de IotId tiene prioridad.

Además de los parámetros específicos de la operación anteriores, debe especificar los parámetros de solicitud comunes al llamar a esta operación. Para obtener más información, consulte Parámetros de solicitud comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	El código de error devuelto si la llamada falla. Para obtener más información, consulte Códigos de error.
Data	Struct		Los detalles del dispositivo devueltos si la llamada es exitosa.
DeviceName	String	light	El DeviceName del dispositivo.
DeviceSecret	String	mz2Canp4GB7qRVf1OYPNtRqB2anu****	El DeviceSecret del dispositivo.
FirmwareVersion	String	V1.0.0.0	El número de versión del módulo OTA predeterminado del dispositivo. Para consultar la información de versión de otros módulos OTA, llame a la operación ListOTAModuleVersionsByDevice. El dispositivo envía esta información de versión.
GmtActive	String	2018-08-06 10:48:41	La hora en que se activó el dispositivo, en formato GMT.
GmtCreate	String	2018-08-06 10:47:50	La hora en que se creó el dispositivo, en formato GMT.
GmtOnline	String	2018-08-06 13:43:12	La última vez que el dispositivo estuvo en línea, en formato GMT.
IotId	String	Q7uOhVRdZRRlDnTLv****00100	El ID del dispositivo. Es el identificador único que IoT Platform asigna al dispositivo.
IpAddress	String	10.0.0.1	La dirección IP del dispositivo.
Nickname	String	detectors_in_beijing	El alias del dispositivo.
NodeType	Integer	0	El tipo de nodo. Valores válidos: 0: dispositivo. No admite subdispositivos. Puede conectarse a IoT Platform directamente o como subdispositivo de una puerta de enlace. 1: puerta de enlace. Admite subdispositivos. Gestiona los subdispositivos, mantiene las relaciones topológicas con ellos y sincroniza dichas relaciones con IoT Platform.
Owner	Boolean	true	Indica si el propietario del dispositivo llamó a la operación.
ProductKey	String	a1rYuVF****	La ProductKey del producto al que pertenece el dispositivo.
ProductName	String	test	El nombre del producto al que pertenece el dispositivo.
Region	String	cn-shanghai	El ID de la región donde reside el dispositivo. Corresponde a la misma región de IoT Platform. Consulte la región en la consola de IoT Platform.
Status	String	ONLINE	El estado del dispositivo. Valores válidos: ONLINE: El dispositivo está en línea. OFFLINE: El dispositivo está desconectado. UNACTIVE: El dispositivo no está activado. DISABLE: El dispositivo está deshabilitado.
UtcActive	String	2018-08-06T02:48:41.000Z	La hora en que se activó el dispositivo, en formato UTC.
UtcCreate	String	2018-08-06T02:47:50.000Z	La hora en que se creó el dispositivo, en formato UTC.
UtcOnline	String	2018-08-06T05:43:12.000Z	La última vez que el dispositivo estuvo en línea, en formato UTC.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la llamada falla.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	El ID de la solicitud.
Success	Boolean	true	Indica si la llamada fue exitosa. true: La llamada fue exitosa. false: La llamada falló.

Ejemplos

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

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 error

Para obtener una lista de códigos de error, visite el Centro de errores de API.