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

Consulta el estado de varios dispositivos en una sola llamada.

Descripción general

Puede usar esta operación de las siguientes maneras:

Especifique los valores de ProductKey y varios de DeviceName para consultar dispositivos del mismo producto.
Especifique varios valores de IotId para consultar dispositivos de distintos productos.

Importante

Puede consultar el estado de hasta 50 dispositivos en una sola llamada.

Límites de QPS

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

Nota

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

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Le recomendamos llamar a esta operación desde OpenAPI Explorer, ya que genera dinámicamente código de ejemplo para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	BatchGetDeviceState	La operación que se va a ejecutar. Establezca el valor en BatchGetDeviceState.
DeviceName.N	RepeatList	No	light	Los nombres de los dispositivos. Importante Este parámetro requiere ProductKey.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	El ID de la instancia. Puede consultarlo en la página Overview de la consola de IoT Platform. Importante Obligatorio si su instancia tiene un ID. De lo contrario, la llamada fallará. No es obligatorio si no se generó una página Overview o un ID para su instancia. Descripción general
ProductKey	String	No	a1BwAGV****	El ProductKey del producto al que pertenece el dispositivo. Importante Este parámetro requiere DeviceName.
IotId.N	RepeatList	No	Q7uOhVRdZRRlDnTLv****00100	Los ID de los dispositivos. Importante IotId es un GUID que corresponde a una combinación de ProductKey y DeviceName. Si especifica IotId, no necesita especificar ProductKey ni DeviceName. Si se especifican los tres, IotId tiene prioridad.

Esta operación también requiere 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. Códigos de error
DeviceStatusList	Array of DeviceStatus		La lista de estados de dispositivos devuelta en caso de éxito. Contiene los parámetros DeviceStatus que se enumeran a continuación.
DeviceStatus
AsAddress	String	192.0.2.1	La dirección IP del dispositivo.
DeviceId	String	dwnS41bhNxjslDAI****	El ID del dispositivo (obsoleto). Nota Obsoleto. Use IotId o una combinación de ProductKey y DeviceName en su lugar.
DeviceName	String	light	El DeviceName del dispositivo.
IotId	String	dwnS41bhNxjslDAI****000100	El identificador único que IoT Platform asignó al dispositivo.
LastOnlineTime	String	2020-01-17 16:19:11	La última vez que el dispositivo estuvo en línea.
Status	String	OFFLINE	El estado del dispositivo. Valores válidos: ONLINE: El dispositivo está en línea. OFFLINE: El dispositivo está fuera de línea. UNACTIVE: El dispositivo no está activado. DISABLE: El dispositivo está deshabilitado.
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 se realizó correctamente. Valores válidos: true: La llamada fue exitosa. false: La llamada falló.

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=BatchGetDeviceState
&productKey=a1BwAGV****
&DeviceName.1=device1
&DeviceName.2=device2
&<Common request parameters>

Respuesta exitosa de ejemplo

Formato XML

<BatchGetDeviceStateResponse>
  <DeviceStatusList>
        <DeviceStatus>
              <Status>OFFLINE</Status>
              <DeviceId>dwnS41bhNxjslDAI****</DeviceId>
              <DeviceName>Humidity</DeviceName>
              <AsAddress>192.0.2.1</AsAddress>
              <LastOnlineTime>2020-01-17 16:19:11</LastOnlineTime>
              <IotId>dwnS41bhNxjslDAI****000100</IotId>
        </DeviceStatus>
  </DeviceStatusList>
  <RequestId>3258D872-EDC5-4039-B564-C27ED7176741</RequestId>
  <Success>true</Success>
</BatchGetDeviceStateResponse>

Formato JSON

{
	"DeviceStatusList": {
		"DeviceStatus": [
			{
				"Status": "OFFLINE",
				"DeviceId": "dwnS41bhNxjslDAI****",
				"DeviceName": "Humidity",
				"AsAddress": "192.0.2.1",
				"LastOnlineTime": "2020-01-17 16:19:11",
				"IotId": "dwnS41bhNxjslDAI****000100"
			}
		]
	},
	"RequestId": "3258D872-EDC5-4039-B564-C27ED7176741",
	"Success": true
}

Códigos de error

Hay códigos de error adicionales disponibles en Códigos de error del servicio.