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

Consulta el estado de un dispositivo.

Límites

Cada cuenta de Alibaba Cloud admite un máximo de 500 consultas por segundo (QPS).

Nota

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

Depuración

Alibaba Cloud ofrece OpenAPI Explorer para simplificar el uso de la API. OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, se recomienda llamar a esta operación desde OpenAPI Explorer. Esta herramienta 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í	GetDeviceStatus	La operación que desea ejecutar. Establezca el valor en GetDeviceStatus.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	El ID de la instancia. Consulte el ID de la instancia en la página de Descripción general de la consola de IoT Platform. Importante Si su instancia tiene un ID, configure este parámetro. De lo contrario, la llamada fallará. Si su instancia no tiene página de Descripción general o ID, omita 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 este parámetro, también debe especificar el parámetro DeviceName.
DeviceName	String	No	light	El DeviceName del dispositivo. Nota Si especifica este parámetro, también debe especificar el parámetro ProductKey.
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	El ID del dispositivo. Es un identificador único asignado por IoT Platform. Nota Si especifica este parámetro, no necesita especificar ProductKey ni DeviceName. El parámetro IotId define un identificador único global (GUID) del dispositivo, que corresponde a la combinación de ProductKey y DeviceName. Si especifica tanto IotId como la combinación de ProductKey y DeviceName, IotId tendrá prioridad.

Además de los parámetros específicos de la operación mencionados anteriormente, especifique 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		El estado del dispositivo devuelto si la llamada es exitosa.
Status	String	ONLINE	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.
Timestamp	Long	1557062301656	La hora en que cambió el estado del dispositivo.
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=GetDeviceStatus
&ProductKey=a1rYuVF****
&DeviceName=device1
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<GetDeviceStatusResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <Status>ONLINE</Status>
        <Timestamp>1557062301656</Timestamp>
  </Data>
  <Success>true</Success>
</GetDeviceStatusResponse>

Formato JSON

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "Status": "ONLINE",
        "Timestamp": 1557062301656
    },
    "Success": true
}

Códigos de error

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