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

Consulta los detalles de un producto.

Límites

Cada cuenta de Alibaba Cloud puede ejecutar un máximo de 50 consultas por segundo (QPS).

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, se recomienda llamar a 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í	QueryProduct	La operación que desea ejecutar. Establezca el valor en QueryProduct.
ProductKey	String	Sí	a1BwAGV****	El ProductKey del producto que desea consultar. Un ProductKey es un GUID emitido por IoT Platform para un producto. Use la consola de IoT Platform o llame a la operación QueryProductList para consultar la información de todos los productos de la cuenta actual.
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 la página Overview ni ID, no es necesario establecer este parámetro. Para obtener más información, consulte Descripción general.

Además de los parámetros de solicitud específicos de la operación anteriores, 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	El código de error devuelto si la llamada falla. Para obtener más información, consulte Códigos de error.
Data	Struct		La información del producto devuelta si la llamada es exitosa.
AliyunCommodityCode	String	iothub_senior	El tipo de producto. Este parámetro indica si se utilizó un modelo de Thing Specification Language (TSL). Valores válidos: iothub_senior: se utilizó un modelo TSL. iothub: no se utilizó ningún modelo TSL.
AuthType	String	secret	El método de autenticación utilizado para conectar los dispositivos del producto a IoT Platform. Valores válidos: secret: se usaron DeviceSecrets para autenticar los dispositivos. id2: se usó IoT Internet Device ID para autenticar los dispositivos. x509: se usaron certificados X.509 para autenticar los dispositivos.
CategoryKey	String	Lighting	El identificador de la categoría a la que pertenece el producto. Este parámetro se devuelve si el producto utiliza el modelo TSL de una categoría estándar predefinida por IoT Platform. Este parámetro está disponible si el parámetro AliyunCommodityCode se establece en iothub_senior.
CategoryName	String	Street Lamp	El nombre de la categoría del producto. Este parámetro se devuelve si el producto utiliza el modelo TSL de una categoría estándar predefinida por IoT Platform. Este parámetro está disponible si el parámetro AliyunCommodityCode se establece en iothub_senior.
DataFormat	Integer	1	El formato de datos que utilizó un protocolo de comunicación para transmitir datos entre los dispositivos e IoT Platform. Este parámetro está disponible si el parámetro AliyunCommodityCode se establece en iothub_senior. Valores válidos: 0: personalizado. Se utilizó un formato de datos en serie personalizado. En este caso, el dispositivo puede enviar datos sin procesar, como flujos de datos binarios. IoT Platform convierte los datos sin procesar en datos Alink JSON estándar mediante un script de análisis de datos específico. 1: Alink JSON. Los datos Alink JSON se transmiten entre los dispositivos e IoT Platform. Alink es un protocolo de intercambio de datos predefinido por IoT Platform.
Description	String	Smart street light	La descripción del producto.
DeviceCount	Integer	0	La cantidad de dispositivos asociados al producto.
GmtCreate	Long	1581595942000	La hora en la que se creó el producto. El valor es una marca de tiempo en milisegundos.
Id2	Boolean	false	Indica si IoT Internet Device ID estaba habilitado. Valores válidos: true: IoT Internet Device ID estaba habilitado. false: IoT Internet Device ID estaba deshabilitado.
NetType	Integer	3	El método de conexión de red. Valores válidos: 3: Wi-Fi. 6: red celular (2G/3G/4G/5G). 7: Ethernet. 8: otros.
NodeType	Integer	0	El tipo de nodo del producto. Este parámetro está disponible si el parámetro AliyunCommodityCode se establece en iothub_senior. 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.
Owner	Boolean	true	Indica si el propietario del producto llamó a la operación. true: sí. false: no.
ProductKey	String	a1T27vz****	El ProductKey del producto. Cuando usted crea un producto, un ProductKey es el identificador único global (GUID) emitido por IoT Platform para dicho producto.
ProductName	String	Street light	El nombre del producto.
ProductSecret	String	U5tW7i44uilc****	El ProductSecret del producto.
ProductStatus	String	DEVELOPMENT_STATUS	El estado del producto. DEVELOPMENT_STATUS: el producto está en desarrollo. RELEASE_STATUS: el producto ya se publicó.
ProtocolType	String	modbus	El tipo de protocolo que utilizaron los subdispositivos para conectarse a una puerta de enlace. Este parámetro está disponible si el parámetro AliyunCommodityCode se establece en iothub_senior y el parámetro NodeType se establece en 1. Valores válidos: modbus: Modbus. opc-ua: OPC UA. customize: protocolo personalizado. ble: BLE. zigbee: ZigBee.
ValidateType	Integer	1	El nivel de verificación de datos. Valores válidos: 2: sin verificación. IoT Platform no verifica los datos; todos se reenvían. En la consola de IoT Platform, los datos no se muestran en la pestaña TSL Data de la página Device Details. 1: verificación de nivel bajo. IoT Platform solo verifica los campos identifier y dataType de los datos. Todos los datos se reenvían. 0: verificación de nivel alto. IoT Platform verifica todos los campos de los datos. Solo se reenvían los datos que superan la verificación. Los productos creados antes del 14 de octubre de 2020 solo admiten la verificación de nivel alto. Los productos creados a partir del 14 de octubre de 2020 admiten la verificación de nivel bajo o la ausencia de verificación. Después de la verificación, puede consultar los datos que la superaron o que resultaron con errores. En la consola de IoT Platform, los datos se muestran en la pestaña TSL Data de la página Device Details. Los datos que no superan la verificación no se muestran. Puede consultar los datos con errores en el parámetro checkFailedData de los datos reenviados. Para obtener más información, consulte Formatos de datos.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la llamada falla.
RequestId	String	E4F94B97-1D64-4080-BFD2-67461667AA43	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=QueryProduct
&ProductKey=a1BwAGV****
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<QueryProductResponse>
  <Data>
        <Owner>true</Owner>
        <CategoryName>Street lighting</CategoryName>
        <DataFormat>1</DataFormat>
        <ProductKey>a1BwAGV****</ProductKey>
        <ProductStatus>DEVELOPMENT_STATUS</ProductStatus>
        <GmtCreate>1581595942000</GmtCreate>
        <ProductSecret>U5tW7i44uilc****</ProductSecret>
        <NodeType>0</NodeType>
        <ProductName>Street light</ProductName>
        <ValidateType>1</ValidateType>
        <DeviceCount>0</DeviceCount>
        <NetType>3</NetType>
        <AuthType>secret</AuthType>
        <CategoryKey>Lighting</CategoryKey>
        <Id2>false</Id2>
        <AliyunCommodityCode>iothub_senior</AliyunCommodityCode>
  </Data>
  <RequestId>DA5A3C45-D457-48ED-9A20-AEDEA8503401</RequestId>
  <Success>true</Success>
</QueryProductResponse>

Formato JSON

{
    "Data": {
        "Owner": true,
        "CategoryName": "Street lighting",
        "DataFormat": 1,
        "ProductKey": "a1BwAGV****",
        "ProductStatus": "DEVELOPMENT_STATUS",
        "GmtCreate": 1581595942000,
        "ProductSecret": "U5tW7i44uilc****",
        "NodeType": 0,
        "ProductName": "Street light"
        "ValidateType":1,
        "DeviceCount": 0,
        "NetType": 3,
        "AuthType": "secret",
        "CategoryKey": "Lighting",
        "Id2": false,
        "AliyunCommodityCode": "iothub_senior"
    },
    "RequestId": "DA5A3C45-D457-48ED-9A20-AEDEA8503401",
    "Success": true
}

Códigos de error

Para consultar la lista de códigos de error, visite el centro de errores de API.