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

Obtiene una lista de dispositivos filtrada por estado.

Notas de uso

Cuando cambia el estado de un dispositivo, el nuevo estado surte efecto en un plazo de 10 segundos. Hasta que se aplica la actualización, el dispositivo solo puede buscarse por su estado anterior.

Límites de QPS

Puede invocar esta operación de API hasta 50 veces por segundo por cuenta.

Nota

Los usuarios de 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 mayor comodidad, le recomendamos invocar 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í	QueryDeviceByStatus	La operación que desea ejecutar. Establezca el valor en QueryDeviceByStatus.
Status	Integer	Sí	1	El estado del dispositivo. Valores válidos: 0: El dispositivo está inactivo. 1: El dispositivo está en línea. 3: El dispositivo está sin conexión. 8: El dispositivo está deshabilitado.
IotInstanceId	String	No	iot_instc_pu*_c-v64	El ID de la instancia. Puede consultar el ID de la instancia en la pestaña Overview de la consola de IoT Platform. Importante Si la instancia tiene un ID, debe especificar este parámetro. De lo contrario, la solicitud fallará. Si la pestaña Overview o el ID de la instancia no se muestran en la consola de IoT Platform, no es necesario especificar este parámetro.
ProductKey	String	No	a1BwAGV****	La clave ProductKey del producto al que pertenece el dispositivo.
CurrentPage	Integer	No	1	El número de página.
PageSize	Integer	No	10	El número de entradas por página. Valores válidos: de 1 a 50.
ResourceGroupId	String	No	rg-acfm4l5tcwd***	El ID del resource group. Importante IoT Platform admite la gestión de resource groups únicamente por instancia. El parámetro ResourceGroupId no es válido. No es necesario especificar este parámetro.

Además de los parámetros específicos de la operación, debe especificar los parámetros de solicitud comunes al invocar 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 en caso de fallo. Para obtener más información, consulte Códigos de error.
Data	Array of SimpleDeviceInfo		La información del dispositivo devuelta en caso de éxito. El parámetro SimpleDeviceInfo contiene los detalles del dispositivo.
SimpleDeviceInfo
DeviceName	String	light	El nombre del dispositivo.
DeviceSecret	String	sLefbFmN9SYfnWLJTePG893XNuRV****	El secreto del dispositivo.
GmtCreate	String	2021-02-18 10:46:32	La hora de creación del dispositivo, en formato GMT.
GmtModified	String	2021-02-18 10:46:32	La hora de la última modificación del dispositivo, en formato GMT.
IotId	String	Av8NGHGtwPrH9BYGLMBi00****	El ID del dispositivo.
Nickname	String	SensorInShanghai	El alias del dispositivo.
ProductKey	String	a1BwAGV****	La clave ProductKey del producto al que pertenece el dispositivo.
Status	String	ONLINE	El estado del dispositivo. Valores válidos: UNACTIVE: El dispositivo está inactivo. ONLINE: El dispositivo está en línea. OFFLINE: El dispositivo está sin conexión. DISABLE: El dispositivo está deshabilitado.
UtcCreate	String	2021-02-18T02:46:32.000Z	La hora de creación del dispositivo, en formato UTC.
UtcModified	String	2021-02-18T02:46:32.000Z	La hora de la última modificación del dispositivo, en formato UTC.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto en caso de fallo.
Page	Integer	1	El número de página.
PageCount	Integer	1	El número total de páginas.
PageSize	Integer	10	El número de entradas por página.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	El ID de la solicitud.
Success	Boolean	true	Indica si la solicitud se realizó correctamente. Valores válidos: true false
Total	Integer	2	El número total de dispositivos devueltos.

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceByStatus
&ProductKey=aldafD****
&Status=0
&PageSize=10
&CurrentPage=1
&<Common request parameters>

Respuestas de éxito de ejemplo

XML formato

<QueryDeviceByStatusResponse>
      <RequestId>CD9E5F99-A095-4A05-9256-D924EA3075E8</RequestId>
      <Success>true</Success>
      <CurrentPage>1</CurrentPage>
      <PageSize>10</PageSize>
      <TotalPageCount>1</TotalPageCount>
      <TotalCount>2</TotalCount>
      <Data>
            <SimpleDeviceInfo>
                  <IotId>Av8NGHGtwPrH9BYGLMBi00****</IotId>
                  <DeviceName>Av8NGHG***</DeviceName>
                  <ProductKey>a1dafDE****</ProductKey>
                  <DeviceSecret>d7GYhf5hfcPHDe1bXSd3n9MjO1G3****</DeviceSecret>
                  <UtcModified>2021-02-18T02:46:32.000Z</UtcModified>
                  <GmtCreate>2021-02-18 10:46:32</GmtCreate>
                  <UtcCreate>2021-02-18T02:46:32.000Z</UtcCreate>
                  <GmtModified>2021-02-18 10:46:32</GmtModified>
                  <Status>UNACTIVE</Status>
                  <Nickname>SensorInShanghai</Nickname>
            </SimpleDeviceInfo>
            <SimpleDeviceInfo>
                  <IotId>zNIcSmWQ9BPJlmkjn3H100****</IotId>
                  <DeviceName>zNIcSmWQ***</DeviceName>
                  <ProductKey>a1dafDE****</ProductKey>
                  <DeviceSecret>C27XXmC18yLIEDXvUj6FSlvgO7ag****</DeviceSecret>
                  <UtcModified>2021-02-09T09:44:55.000Z</UtcModified>
                  <GmtCreate>2021-02-09 17:44:55</GmtCreate>
                  <UtcCreate>2021-02-09T09:44:55.000Z</UtcCreate>
                  <GmtModified>2021-02-09 17:44:55</GmtModified>
                  <DeviceStatus>UNACTIVE</DeviceStatus>
                  <Nickname>DriverInShanghai</Nickname>
            </SimpleDeviceInfo>
      </Data>
</QueryDeviceByStatusResponse>

JSON formato

{
  "RequestId": "CD9E5F99-A095-4A05-9256-D924EA3075E8", 
  "Success": true,  
  "CurrentPage": 1, 
  "PageSize": 10, 
  "TotalPageCount": 1,
  "TotalCount": 2,
  "Data": {
    "SimpleDeviceInfo": [
      {
        "IotId": "Av8NGHGtwPrH9BYGLMBi00****", 
        "DeviceName": "Av8NGHG***", 
        "ProductKey": "a1dafDE****", 
        "DeviceSecret": "d7GYhf5hfcPHDe1bXSd3n9MjO1G3****", 
        "UtcModified": "2021-02-18T02:46:32.000Z", 
        "GmtCreate": "2021-02-18 10:46:32", 
        "UtcCreate": "2021-02-18T02:46:32.000Z", 
        "GmtModified": "2021-02-18 10:46:32", 
        "Status": "UNACTIVE", 
        "Nickname": "SensorInShanghai"
      }, 
      {
        "IotId": "zNIcSmWQ9BPJlmkjn3H100****", 
        "DeviceName": "zNIcSmWQ***", 
        "ProductKey": "a1dafDE****", 
        "DeviceSecret": "C27XXmC18yLIEDXvUj6FSlvgO7ag****", 
        "UtcModified": "2021-02-09T09:44:55.000Z", 
        "GmtCreate": "2021-02-09 17:44:55", 
        "UtcCreate": "2021-02-09T09:44:55.000Z", 
        "GmtModified": "2021-02-09 17:44:55", 
        "DeviceStatus": "UNACTIVE", 
        "Nickname": "DriverInShanghai"
      }
    ]
  }  
}

Códigos de error

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