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

Consulta los detalles de varios dispositivos en un producto especificado.

Notas de uso

Puede consultar hasta 100 dispositivos en una sola llamada.
Solo puede consultar dispositivos que pertenezcan a la cuenta actual de Alibaba Cloud. Si especifica un dispositivo que no pertenece a la cuenta actual, se devuelve un mensaje de error.
Si especifica dispositivos que no existen, solo se devuelven los detalles de los dispositivos existentes.

Límites de QPS

Puede llamar a esta operación de API hasta cinco veces por segundo por cuenta.

Nota

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

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos que llame 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í	BatchQueryDeviceDetail	La operación que desea ejecutar. Establezca el valor en BatchQueryDeviceDetail.
DeviceName.N	RepeatList	Sí	light	Los DeviceNames de los dispositivos. Puede especificar hasta 100 DeviceNames. Nota Los dispositivos deben pertenecer al mismo producto.
ProductKey	String	Sí	a1BwAGV****	El ProductKey del producto al que pertenecen los dispositivos cuyos DeviceNames se especificaron mediante el parámetro DeviceName.N.
IotInstanceId	String	No	iot-v64***	El ID de la instancia. Puede consultar el ID de la instancia en la página Descripción general de la consola de IoT Platform. Importante Si su instancia tiene un ID, debe especificarlo en este parámetro. De lo contrario, la llamada fallará. Si no se generó ninguna página Descripción general o ID para su instancia, no es necesario configurar este parámetro. Para obtener más información, consulte Descripción general de instancias.

Además de los parámetros de solicitud específicos de la operación, debe configurar los parámetros de solicitud comunes al llamar a esta operación. Para obtener más información, consulte Parámetros 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	Array of Data		Los detalles del dispositivo devueltos si la llamada es exitosa.
Data
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 información de versión sobre otros módulos OTA, llame a la operación ListOTAModuleVersionsByDevice. El dispositivo envía la información de versión.
GmtActive	String	2019-06-21 20:33:00	La hora en que se activó el dispositivo. La hora está en formato GMT.
GmtCreate	String	2019-06-21 20:31:42	La hora en que se creó el dispositivo. La hora está en formato GMT.
IotId	String	Q7uOhVRdZRRlDnTLv****00100	El ID del dispositivo. Este identificador único lo emite IoT Platform para el dispositivo.
Nickname	String	Smart street light	El alias del dispositivo.
NodeType	Integer	0	El tipo de nodo. Valores válidos: 0: dispositivo. No se pueden adjuntar subdispositivos a un dispositivo. Un dispositivo puede conectarse a IoT Platform directamente o como subdispositivo de una puerta de enlace. 1: puerta de enlace. Se pueden adjuntar subdispositivos a una puerta de enlace. Una puerta de enlace puede gestionar subdispositivos, mantener relaciones topológicas con ellos y sincronizar dichas relaciones con IoT Platform.
ProductKey	String	a1BwAGV****	El ProductKey del producto al que pertenece el dispositivo.
ProductName	String	Street light	El nombre del producto al que pertenece el dispositivo.
Region	String	cn-shanghai	El ID de región del dispositivo. Es la misma región que la de IoT Platform. Puede consultar 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á sin conexión. UNACTIVE: El dispositivo no está activado. DISABLE: El dispositivo está deshabilitado.
UtcActive	String	2019-06-21T12:31:42.000Z	La hora en que se activó el dispositivo. La hora está en formato UTC.
UtcCreate	String	2019-06-21T12:31:42.000Z	La hora en que se creó el dispositivo. La hora está 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=BatchQueryDeviceDetail
&ProductKey=a1fce6J****
&DeviceName.1=firstDeviceName
&DeviceName.2=secondDeviceName
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<BatchQueryDeviceDetailResponse>
  <Data>
        <Data>
              <DeviceName>Humidity</DeviceName>
              <GmtActive>2020-01-16 13:33:37</GmtActive>
              <ProductKey>a1ttsqu****</ProductKey>
              <DeviceSecret>sLefbFmN9SYfnWLJTePG893XNuRV****</DeviceSecret>
              <GmtCreate>2020-01-08 14:47:08</GmtCreate>
              <UtcCreate>2020-01-08T06:47:08.000Z</UtcCreate>
              <IotId>dwnS41bhNxjslDAIF****00100</IotId>
              <Status>OFFLINE</Status>
              <UtcActive>2020-01-08T06:47:08.000Z</UtcActive>
              <Region>cn-shanghai</Region>
              <NickName>Temperature and humidity</NickName>
              <NodeType>0</NodeType>
              <ProductName>Light, temperature, and humidity sensor</ProductName>
        </Data>
        <Data>
              <Status>OFFLINE</Status>
              <GmtActive>2020-01-17 16:23:15</GmtActive>
              <DeviceName>TH_sensor</DeviceName>
              <Region>cn-shanghai</Region>
              <UtcActive>2020-01-17T03:39:14.000Z</UtcActive>
              <ProductKey>a1ttsqu****</ProductKey>
              <NodeType>0</NodeType>
              <DeviceSecret>dCYdTU3gw5Z77bsHjPk6lPHPVnBT****</DeviceSecret>
              <ProductName>Light, temperature, and humidity sensor</ProductName>
              <GmtCreate>2020-01-17 11:39:14</GmtCreate>
              <UtcCreate>2020-01-17T03:39:14.000Z</UtcCreate>
              <IotId>RKYkCRstfGBh5SZXL****00100</IotId>
        </Data>
  </Data>
  <RequestId>D4C12DD8-4390-4877-B1DC-4049CF4868BC</RequestId>
  <Success>true</Success>
</BatchQueryDeviceDetailResponse>

Formato JSON

{
	"Data": {
		"Data": [
			{
				"DeviceName": "Humidity",
				"GmtActive": "2020-01-16 13:33:37",
				"ProductKey": "a1ttsqu****",
				"DeviceSecret": "sLefbFmN9SYfnWLJTePG893XNuRV****",
				"GmtCreate": "2020-01-08 14:47:08",
				"UtcCreate": "2020-01-08T06:47:08.000Z",
				"IotId": "dwnS41bhNxjslDAIF****00100",
				"Status": "OFFLINE",
				"UtcActive": "2020-01-08T06:47:08.000Z",
				"Region": "cn-shanghai",
				"NickName": "Temperature and humidity",
				"NodeType": 0,
				"ProductName": "Light, temperature, and humidity sensor"
			},
			{
				"Status": "OFFLINE",
				"GmtActive": "2020-01-17 16:23:15",
				"DeviceName": "TH_sensor",
				"Region": "cn-shanghai",
				"UtcActive": "2020-01-17T03:39:14.000Z",
				"ProductKey": "a1ttsqu****",
				"NodeType": 0,
				"DeviceSecret": "dCYdTU3gw5Z77bsHjPk6lPHPVnBT****",
				"ProductName": "Light, temperature, and humidity sensor",
				"GmtCreate": "2020-01-17 11:39:14",
				"UtcCreate": "2020-01-17T03:39:14.000Z",
				"IotId": "RKYkCRstfGBh5SZXL****00100"
			}
		]
	},
	"RequestId": "D4C12DD8-4390-4877-B1DC-4049CF4868BC",
	"Success": true
}

Códigos de error

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.