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

Consulta todos los productos.

Notas de uso

Si el valor especificado para CurrentPage es mayor que el valor de PageCount al llamar a la operación QueryProductList, ProductInfo estará vacío. En este caso, especifique nuevos valores para CurrentPage y PageSize según el valor devuelto de Total y vuelva a llamar a la operación QueryProductList para consultar los productos nuevamente.

Por ejemplo, si el valor devuelto de Total es 20 y el valor especificado para PageSize es 5, el valor devuelto de PageCount será 4. El resultado se calcula mediante la siguiente fórmula: 20/5 = 4. Si especifica 1, 2, 3 o 4 para CurrentPage, ProductInfo no estará vacío. Si especifica un valor mayor que 4 para CurrentPage (por ejemplo, 5), ProductInfo estará vacío porque no existen datos en la página 5.

Ejemplo de respuesta exitosa:

{
  "RequestId": "62F56B4D-9CBC-518A-8414-CC91BB83FD04",
  "Data": {
    "PageCount": 4,
    "PageSize": 5,
    "CurrentPage": 5,
    "Total": 20,
    "List": {
      "ProductInfo": []
    }
  },
  "Code": "",
  "Success": true
}

Límites de QPS

Esta operación admite hasta 50 llamadas por segundo por cuenta.

Nota
Los usuarios de RAM de una cuenta de Alibaba Cloud comparten la cuota de dicha cuenta.
Si el producto del valor de CurrentPage y el valor de PageSize es mayor o igual a 100,000, el QPS de esta operación disminuye.

En este caso, cada cuenta de Alibaba Cloud admite hasta 2 QPS.

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 SDKs.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	QueryProductList	La operación que desea ejecutar. Establezca el valor en QueryProductList.
CurrentPage	Integer	Sí	1	El número de página.
PageSize	Integer	Sí	2	El número de entradas por página. Valores válidos: de 1 a 200.
IotInstanceId	String	No	iot_instc_pu*_c-v64	El ID de la instancia. Consulte el ID de la instancia en la pestaña Descripción general de la consola de IoT Platform. Importante Si su instancia tiene un ID, debe especificar el ID para este parámetro. De lo contrario, la llamada fallará. Si su instancia no tiene un ID, no es necesario configurar este parámetro. Para obtener más información, consulte Descripción general.
ResourceGroupId	String	No	rg-acfmxazb4ph****	El ID del resource group. Importante IoT Platform solo permite agregar instancias a un resource group. El parámetro ResourceGroupId ya no surte efecto. No es necesario configurar ResourceGroupId.
AliyunCommodityCode	String	No	iothub_senior	El tipo de producto. Valores válidos: iothub_senior: Se utiliza un modelo de Thing Specification Language (TSL) para el producto. iothub: No se utiliza ningún modelo TSL para el producto. Nota Si no especifica este parámetro, se devolverán todos los productos.

Además de los parámetros de solicitud específicos de la operación mencionados anteriormente, configure los parámetros de solicitud comunes al llamar a esta operación. Para obtener más información sobre los parámetros de solicitud comunes, consulte Common parameters.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	El código de error devuelto si la solicitud falla. Para obtener más información, consulte Error codes.
Data	Struct		La información del producto devuelta si la llamada es exitosa. Para obtener más información, consulte los siguientes parámetros.
CurrentPage	Integer	1	El número de página.
List	Array of ProductInfo		Los productos consultados. Nota Los productos consultados se ordenan en orden cronológico inverso según la hora de creación.
ProductInfo
AuthType	String	secret	El método de autenticación utilizado para conectar los dispositivos del producto a IoT Platform. Valores válidos: secret: Se utilizaron DeviceSecrets para autenticar los dispositivos. id2: Se utilizó IoT Device ID para autenticar los dispositivos. x509: Se utilizaron certificados X.509 para autenticar los dispositivos.
DataFormat	Integer	1	El formato de datos que utiliza un protocolo de comunicación para transmitir datos entre los dispositivos e IoT Platform. Este parámetro se devuelve solo si AliyunCommodityCode está establecido en iothub_senior. Valores válidos: 0: personalizado. Se utiliza un formato de datos serie personalizado. En este caso, los dispositivos pueden enviar datos sin procesar, como flujos de datos binarios. IoT Platform convierte los datos sin procesar en datos JSON Alink estándar mediante un script de análisis de datos específico. 1: JSON Alink. Se transmiten datos JSON Alink entre los dispositivos e IoT Platform. Alink es un protocolo de intercambio de datos predefinido en IoT Platform.
Description	String	This is a test product.	La descripción del producto.
DeviceCount	Integer	128	El número de dispositivos en el producto.
GmtCreate	Long	1581595942000	La hora en que se creó el producto. Este valor es una marca de tiempo UNIX que representa el número de milisegundos transcurridos desde el 1 de enero de 1970, 00:00:00 Hora Universal Coordinada (UTC).
NodeType	Integer	0	El tipo de nodo del producto. Este parámetro se devuelve solo si AliyunCommodityCode está establecido en iothub_senior. Valores válidos: 0: dispositivo. No se pueden adjuntar subdispositivos a un dispositivo. Un dispositivo puede conectarse directamente a IoT Platform o conectarse 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 relaciones topológicas con ellos y sincronizar dichas relaciones con IoT Platform.
ProductKey	String	a1T27vz****	La ProductKey del producto. Una ProductKey es un identificador único global (GUID) que IoT Platform emite para un producto.
ProductName	String	Street light	El nombre del producto.
PageCount	Integer	92	El número total de páginas devueltas.
PageSize	Integer	2	El número de entradas por página.
Total	Integer	184	El número total de productos.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la llamada falla.
RequestId	String	4B4ECF2C-6222-42EC-A4B5-C12202E71CEA	El 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ó.

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryProductList
&CurrentPage=1
&PageSize=2
&ResourceGroupId=rg-acfmxazb4ph****
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<QueryProductListResponse>
  <Data>
        <PageCount>92</PageCount>
        <PageSize>2</PageSize>
        <List>
              <ProductInfo>
                    <DataFormat>1</DataFormat>
                    <ProductKey>a1A0D4t****</ProductKey>
                    <NodeType>0</NodeType>
                    <ProductName>Street light</ProductName>
                    <DeviceCount>1</DeviceCount>
                    <GmtCreate>1569233025000</GmtCreate>
                    <AuthType>secret</AuthType>
              </ProductInfo>
              <ProductInfo>
                    <DataFormat>1</DataFormat>
                    <ProductKey>a1dEvuQ****</ProductKey>
                    <NodeType>0</NodeType>
                    <ProductName>Custom sub-device</ProductName>
                    <DeviceCount>0</DeviceCount>
                    <GmtCreate>1568690432000</GmtCreate>
                    <AuthType>secret</AuthType>
              </ProductInfo>
        </List>
        <CurrentPage>1</CurrentPage>
        <Total>184</Total>
  </Data>
  <RequestId>4B4ECF2C-6222-42EC-A4B5-C12202E71CEA</RequestId>
  <Success>true</Success>
</QueryProductListResponse>

Formato JSON

{
  "Data": {
    "PageCount": 92, 
    "PageSize": 2, 
    "List": {
      "ProductInfo": [
        {
          "DataFormat": 1, 
          "ProductKey": "a1A0D4t****", 
          "NodeType": 0, 
          "ProductName": "Street light", 
          "DeviceCount": 1, 
          "GmtCreate": 1569233025000, 
          "AuthType": "secret"
        }, 
        {
          "DataFormat": 1, 
          "ProductKey": "a1dEvuQ****", 
          "NodeType": 0, 
          "ProductName": "Custom sub-device", 
          "DeviceCount": 0, 
          "GmtCreate": 1568690432000,
          "AuthType": "secret"
        }
      ]
    }, 
    "CurrentPage": 1, 
    "Total": 184
  }, 
  "RequestId": "4B4ECF2C-6222-42EC-A4B5-C12202E71CEA", 
  "Success": true
}

Códigos de error

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