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

Consulta productos por etiqueta.

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.
Especifique una clave de etiqueta o un par clave-valor de etiqueta para la búsqueda.
Si especifica varias etiquetas, la relación lógica entre ellas es OR.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos que llame a esta operación en OpenAPI Explorer. OpenAPI Explorer 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í	ListProductByTags	La operación que se va a ejecutar. Establezca el valor en ListProductByTags.
ProductTag.N.TagKey	String	Sí	room	Las claves de las etiquetas del producto.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	El ID de la instancia. Consulte el ID de la instancia en la página 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 página de Overview ni ID, omita este parámetro. Para obtener más información, consulte Descripción general.
CurrentPage	Integer	No	1	El número de página que se devolverá.
PageSize	Integer	No	10	El número de entradas por página. Valor máximo: 50.
ProductTag.N.TagValue	String	No	102	Los valores de las etiquetas del producto.

Además de los parámetros específicos de la operación anteriores, debe especificar 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.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la llamada falla.
ProductInfos	Array of ProductInfo		Los detalles de los productos devueltos si la llamada es exitosa. Esta información se incluye en el parámetro ProductInfo. Nota La información del producto devuelta se ordena en orden cronológico inverso según la hora de creación de los productos.
ProductInfo
CreateTime	Long	1545355537000	La hora en que se creó el producto.
Description	String	This is a test product.	La descripción del producto.
NodeType	Integer	0	El tipo de nodo del producto. Valores válidos: 0: dispositivo. No se pueden adjuntar subdispositivos a un dispositivo. Un dispositivo puede conectarse a IoT Platform directamente o como subdispositivo de una puerta de enlace. 1: puerta de enlace. Se pueden adjuntar subdispositivos a una puerta de enlace. Una puerta de enlace puede gestionar subdispositivos, mantener las relaciones topológicas con ellos y sincronizar dichas relaciones con IoT Platform.
ProductKey	String	a1BwAGV****	La ProductKey del producto. Una ProductKey es un identificador único global (GUID) emitido por IoT Platform para un nuevo producto.
ProductName	String	Street light	El nombre del producto.
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=ListProductByTags
&CurrentPage=1
&PageSize=10
&ProductTag.1.TagKey=Reen
&ProductTag.1.TagValue=reen
&ProductTag.2.TagKey=Lock
&ProductTag.2.TagValue=1234
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<ListProductByTagsResponse>
  <RequestId>09AA366E-81EC-4CF0-B49E-61BCD7C95338</RequestId>
  <Success>true</Success>
  <ProductInfos>
        <ProductInfo>
              <ProductKey>a1BwAGV****</ProductKey>
              <NodeType>0</NodeType>
              <CreateTime>1581595942000</CreateTime>
              <ProductName>Street light</ProductName>
        </ProductInfo>
        <ProductInfo>
              <ProductKey>a1PO***</ProductKey>
              <NodeType>0</NodeType>
              <CreateTime>1580898565000</CreateTime>
              <ProductName>Sensor </ProductName>
        </ProductInfo>
  </ProductInfos>
</ListProductByTagsResponse>

Formato JSON

{
    "RequestId": "09AA366E-81EC-4CF0-B49E-61BCD7C95338",
    "Success": true,
    "ProductInfos": {
        "ProductInfo": [
            {
                "ProductKey": "a1BwAGV****",
                "NodeType": 0,
                "CreateTime": 1581595942000,
                "ProductName": "Street light"
            },
            {
                "ProductKey": "a1PO***",
                "NodeType": 0,
                "CreateTime": 1580898565000,
                "ProductName": "Sensor"
            }
        ]
    }
}

Códigos de error

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