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

Consulta dispositivos por etiqueta.

Límites

Especifique un máximo de 10 etiquetas en una sola llamada.
Cada cuenta de Alibaba Cloud puede ejecutar un máximo de 5 consultas por segundo (QPS).

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

Depuración

Alibaba Cloud proporciona 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í	QueryDeviceByTags	La operación que desea ejecutar. Establezca el valor en QueryDeviceByTags.
Tag.N.TagKey	String	Sí	room	La clave de la etiqueta del dispositivo.
Tag.N.TagValue	String	Sí	101	El valor de la etiqueta del dispositivo.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	El ID de la instancia. Consulte el ID de la instancia en la página de Overview 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 una página de Overview o ID, omita este parámetro. Para obtener más información, consulte Descripción general.
CurrentPage	Integer	No	1	Número de página que se devolverá. Valor predeterminado: 1.
PageSize	Integer	No	10	Número de entradas que se devolverán en cada página. Valor máximo: 50. Valor predeterminado: 10.

Además de los parámetros de solicitud 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	Código de error devuelto si la llamada falla. Para obtener más información, consulte Códigos de error.
Data	Array of SimpleDeviceInfo		Información del dispositivo devuelta si la llamada es exitosa. El parámetro SimpleDeviceInfo incluye los detalles de los dispositivos.
SimpleDeviceInfo
DeviceName	String	light1	El DeviceName del dispositivo.
IotId	String	Q7uOhVRdZRRlDnTLv****00100	ID del dispositivo. Es el identificador único que IoT Platform asigna al dispositivo.
ProductKey	String	a1BwAGV****	ProductKey del producto al que pertenece el dispositivo.
ProductName	String	lamp	Nombre del producto.
ErrorMessage	String	A system exception occurred.	Mensaje de error devuelto si la llamada falla.
Page	Integer	1	Número de la página devuelta.
PageCount	Integer	1	Número total de páginas.
PageSize	Integer	10	Número de entradas devueltas en cada página.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	ID de la solicitud.
Success	Boolean	true	Indica si la llamada fue exitosa. true: La llamada fue exitosa. false: La llamada falló.
Total	Integer	1	Número total de registros.

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceByTags
&CurrentPage=1
&PageSize=10
&Tag.1.TagKey=room
&Tag.1.TagValue=101
&Tag.2.TagKey=city
&Tag.2.TagValue=hangzhou
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<QueryDeviceByTags>
  <PageCount>1</PageCount>
  <Data>
        <SimpleDeviceInfo>
              <DeviceName>1102jichu02</DeviceName>
              <ProductKey>a1SM5S1****</ProductKey>
              <IotId>GookTiUcwqRbHosp9Ta10****3a00</IotId>
              <ProductName>TEST</ProductName>
        </SimpleDeviceInfo>
  </Data>
  <PageSize>10</PageSize>
  <Page>1</Page>
  <RequestId>2B5091E4-32D5-4884-A5B2-2E8E713D84AF</RequestId>
  <Success>true</Success>
  <Total>1</Total>
</QueryDeviceByTags>

Formato JSON

{
    "PageCount": 1,
    "Data": {
        "SimpleDeviceInfo": [
            {
                "DeviceName": "1102jichu02",
                "ProductKey": "a1SM5S1****",
                "IotId": "GookTiUcwqRbHosp9Ta10****3a00",
                "ProductName": "TEST"
            }
        ]
    },
    "PageSize": 10,
    "Page": 1,
    "RequestId": "2B5091E4-32D5-4884-A5B2-2E8E713D84AF",
    "Success": true,
    "Total": 1
}

Códigos de error

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