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

Consulta los dispositivos de un producto.

Descripción

La operación QueryDevice devuelve hasta un millón de dispositivos cada vez que se invoca.

Límites de QPS

Puede invocar esta API hasta 50 veces por segundo por cuenta.

Nota
Los usuarios RAM de una cuenta de Alibaba Cloud comparten la cuota de dicha cuenta.
Si el resultado de multiplicar el valor del parámetro CurrentPage por el valor del parámetro PageSize es mayor o igual a 100,000, las consultas por segundo (QPS) de esta operación disminuyen.

En este caso, puede invocar esta API hasta dos veces por segundo por cuenta.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para mayor comodidad, le recomendamos invocar esta operación en OpenAPI Explorer. Esta herramienta genera dinámicamente el código de ejemplo de la operación para distintos SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	QueryDevice	Operación que desea ejecutar. Establezca el valor en QueryDevice.
ProductKey	String	Sí	a1BwAGV****	ProductKey del producto al que pertenece el dispositivo.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	ID de la instancia. Consulte el ID de la instancia en la página Overview de la consola de IoT Platform. Importante Si la instancia tiene un ID, especifíquelo en este parámetro. De lo contrario, la llamada falla. Si no se generó ninguna página Overview ni ningún ID para la instancia, no es necesario configurar este parámetro. Para obtener más información, consulte Descripción general.
PageSize	Integer	No	10	Número de entradas que se devuelven en cada página. Valores válidos: de 1 a 50. Valor predeterminado: 10.
CurrentPage	Integer	No	1	Número de la página que se devuelve. Valor predeterminado: 1.
NextToken	String	No	TGlzdFJlc291cm***	Token que se utiliza para recuperar la siguiente página de los resultados de la consulta. En la primera ejecución de la consulta no es necesario configurar este parámetro. Especifique en el parámetro NextToken el token obtenido en la consulta anterior. Si el resultado de multiplicar el valor del parámetro PageSize por el valor del parámetro CurrentPage es mayor que 10,000, configure el parámetro NextToken. De lo contrario, no se pueden devolver datos. Importante Si configura el parámetro NextToken, el resultado de multiplicar el valor del parámetro PageSize por el valor del parámetro CurrentPage debe ser menor que 1,000,000. De lo contrario, no se pueden devolver datos.

Además de los parámetros de solicitud específicos de esta operación, configure los parámetros de solicitud comunes al invocarla. Para obtener más información sobre estos últimos, consulte Parámetros comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	Código de error que se devuelve cuando la llamada falla. Para obtener más información, consulte Códigos de error.
Data	Array of DeviceInfo		Información del dispositivo que se devuelve cuando la llamada es exitosa. Los detalles de los dispositivos se incluyen en el parámetro DeviceInfo. Nota La información de los dispositivos devuelta se ordena de forma cronológica inversa según la hora de creación de cada uno.
DeviceInfo
DeviceId	String	dwnS41bhNxjslDAI****	ID del dispositivo. Nota Este parámetro está obsoleto. No lo utilice para identificar un dispositivo. Use el parámetro IotId o la combinación de los parámetros ProductKey y DeviceName para identificarlo.
DeviceName	String	light	Nombre del dispositivo.
DeviceSecret	String	sLefbFmN9SYfnWLJTePG893XNuRV****	DeviceSecret del dispositivo.
DeviceStatus	String	ONLINE	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á desactivado.
DeviceType	String	Lighting	Categoría del producto al que pertenece el dispositivo. Nota Este parámetro no se devuelve.
GmtCreate	String	Wed, 20-Feb-2019 02:16:09 GMT	Hora en que se creó el dispositivo. Se muestra en formato GMT.
GmtModified	String	Wed, 20-Feb-2019 02:16:09 GMT	Última hora de actualización de la información del dispositivo. Se muestra en formato GMT.
IotId	String	Q7uOhVRdZRRlDnTLv****00100	ID del dispositivo. Es un identificador único que IoT Platform asigna al dispositivo.
Nickname	String	Smart light	Alias del dispositivo.
ProductKey	String	a1BwAGV****	ProductKey del producto al que pertenece el dispositivo.
UtcCreate	String	2019-02-20T02:16:09.000Z	Hora en que se creó el dispositivo. Se muestra en formato UTC.
UtcModified	String	2019-02-20T02:16:09.000Z	Última hora de actualización de la información del dispositivo. Se muestra en formato UTC.
ErrorMessage	String	A system exception occurred.	Mensaje de error que se devuelve cuando la llamada falla.
NextToken	String	TGlzdFJlc291cm***	Token que se utiliza para recuperar la página siguiente de los resultados de la consulta. Especifique este parámetro en la consulta posterior para obtener la siguiente página de resultados. Si el parámetro NextToken está vacío, no existe una página siguiente.
Page	Integer	1	Número de la página devuelta.
PageCount	Integer	1	Número total de páginas devueltas.
PageSize	Integer	10	Número de entradas devueltas por página.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	ID de la solicitud.
Success	Boolean	true	Indica si la llamada fue exitosa. Valores válidos: true: la llamada fue exitosa. false: la llamada falló.
Total	Integer	2	Número total de dispositivos.

Ejemplos

Ejemplos de solicitudes

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

Ejemplos de respuestas exitosas

Formato XML

<QueryDeviceResponse>
  <PageCount>1</PageCount>
  <NextToken>TGlzdFJlc291cm***</NextToken>
  <Data>
        <DeviceInfo>
              <DeviceId>Av8NGHGtwPrH9BYG****</DeviceId>
              <DeviceName>Av8NGHGtwPrH9BYGLMBi</DeviceName>
              <ProductKey>a1dafDE****</ProductKey>
              <DeviceSecret>d7GYhf5hfcPHDe1bXSd3n9MjO1G3****</DeviceSecret>
              <UtcModified>2019-02-20T02:16:09.000Z</UtcModified>
              <GmtCreate>Wed, 20-Feb-2019 02:16:09 GMT</GmtCreate>
              <UtcCreate>2019-02-20T02:16:09.000Z</UtcCreate>
              <GmtModified>Wed, 20-Feb-2019 02:16:09 GMT</GmtModified>
              <IotId>Av8NGHGtwPrH9BYGLMBi00****</IotId>
              <DeviceStatus>UNACTIVE</DeviceStatus>
              <Nickname>SensorInShanghai</Nickname>
        </DeviceInfo>
        <DeviceInfo>
              <DeviceId>zNIcSmWQ9BPJlmkj****</DeviceId>
              <DeviceName>zNIcSmWQ9BPJlmkjn3H1</DeviceName>
              <ProductKey>a1dafDE****</ProductKey>
              <DeviceSecret>C27XXmC18yLIEDXvUj6FSlvgO7ag****</DeviceSecret>
              <UtcModified>2019-02-20T02:16:09.000Z</UtcModified>
              <GmtCreate>Wed, 20-Feb-2019 02:16:09 GMT</GmtCreate>
              <UtcCreate>2019-02-20T02:16:09.000Z</UtcCreate>
              <GmtModified>Wed, 20-Feb-2019 02:16:09 GMT</GmtModified>
              <IotId>zNIcSmWQ9BPJlmkjn3H100****</IotId>
              <DeviceStatus>UNACTIVE</DeviceStatus>
              <Nickname>DriverInShanghai</Nickname>
        </DeviceInfo>
  </Data>
  <Page>1</Page>
  <PageSize>10</PageSize>
  <RequestId>CD9E5F99-A095-4A05-9256-D924EA3075E8</RequestId>
  <Success>true</Success>
  <Total>2</Total>
</QueryDeviceResponse>

Formato JSON

{
  "PageCount": 1,
  "NextToken":"TGlzdFJlc291cm***", 
  "Data": {
    "DeviceInfo": [
      {
        "DeviceId": "Av8NGHGtwPrH9BYG****", 
        "DeviceName": "Av8NGHGtwPrH9BYGLMBi", 
        "ProductKey": "a1dafDE****", 
        "DeviceSecret": "d7GYhf5hfcPHDe1bXSd3n9MjO1G3****", 
        "UtcModified": "2019-02-20T02:16:09.000Z", 
        "GmtCreate": "Wed, 20-Feb-2019 02:16:09 GMT", 
        "UtcCreate": "2019-02-20T02:16:09.000Z", 
        "GmtModified": "Wed, 20-Feb-2019 02:16:09 GMT", 
        "IotId": "Av8NGHGtwPrH9BYGLMBi00****", 
        "DeviceStatus": "UNACTIVE", 
        "Nickname": "SensorInShanghai"
      }, 
      {
        "DeviceId": "zNIcSmWQ9BPJlmkj****", 
        "DeviceName": "zNIcSmWQ9BPJlmkjn3H1", 
        "ProductKey": "a1dafDE****", 
        "DeviceSecret": "C27XXmC18yLIEDXvUj6FSlvgO7ag****", 
        "UtcModified": "2019-02-20T02:16:09.000Z", 
        "GmtCreate": "Wed, 20-Feb-2019 02:16:09 GMT", 
        "UtcCreate": "2019-02-20T02:16:09.000Z", 
        "GmtModified": "Wed, 20-Feb-2019 02:16:09 GMT", 
        "IotId": "zNIcSmWQ9BPJlmkjn3H100****", 
        "DeviceStatus": "UNACTIVE", 
        "Nickname": "DriverInShanghai"
      }
    ]
  }, 
  "Page": 1, 
  "PageSize": 10, 
  "RequestId": "CD9E5F99-A095-4A05-9256-D924EA3075E8", 
  "Success": true, 
  "Total": 2
}

Códigos de error

Para ver la lista de códigos de error, consulte Códigos de error del servicio.