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

Crea un producto.

Notas de uso

Si se requiere un modelo de Thing Specification Language (TSL) para crear un producto, establezca el parámetro AliyunCommodityCode en iothub_senior y especifique el parámetro DataFormat. Para obtener más información, consulte la sección Request parameters de este tema.

Límites de QPS

Puede llamar a esta operación hasta 50 veces por segundo por cuenta.

Nota

Los usuarios de Resource Access Management (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 su comodidad, le recomendamos llamar 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í	CreateProduct	La operación que desea ejecutar. Establezca el valor en CreateProduct.
NodeType	Integer	Sí	0	El tipo de nodo del producto. Valores válidos: 0: dispositivo. No se pueden conectar subdispositivos a un dispositivo. Un dispositivo puede conectarse directamente a IoT Platform o como subdispositivo de una puerta de enlace. Si utiliza el dispositivo como subdispositivo de una puerta de enlace, especifique ProtocolType. 1: puerta de enlace. Se pueden conectar 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.
ProductName	String	Sí	Light	El nombre del producto. El nombre debe tener entre 4 y 30 caracteres, y puede contener letras, dígitos y guiones bajos (_). Cada carácter chino cuenta como dos caracteres. Importante Cada nombre de producto debe ser único dentro de la instancia actual.
IotInstanceId	String	No	iot-*-v64*	El ID de la instancia. Consulte el ID de la instancia en la página Descripción general de la consola de IoT Platform. Importante Si su instancia tiene un ID, especifique este parámetro. De lo contrario, la solicitud fallará. Si la página Descripción general o el ID de la instancia no se muestran en la consola de IoT Platform, no es necesario especificar este parámetro. Para obtener más información, consulte Descripción general.
DataFormat	Integer	No	1	El formato de datos. Valores válidos: 0: formato de datos personalizado. 1: formato Alink JSON.
Description	String	No	Prueba de producto	La descripción del producto. La descripción puede tener hasta 100 caracteres.
AliyunCommodityCode	String	No	iothub_senior	La edición del producto. De forma predeterminada, si no especifica este parámetro, se crea automáticamente un producto de la Edición Básica. No puede utilizar un modelo TSL para definir el producto. Si desea especificar este parámetro, establezca el valor en iothub_senior. En este caso, se crea un producto compatible con modelos TSL. También debe especificar el parámetro DataFormat. Importante Para productos de la Edición Básica, no puede utilizar la función online debugging en la consola de IoT Platform.
Id2	Boolean	No	false	No es necesario especificar este parámetro.
ProtocolType	String	No	modbus	El protocolo que utilizan los dispositivos del producto para conectarse a la puerta de enlace. Si AliyunCommodityCode está establecido en iothub_senior y se requiere una puerta de enlace para conectar los dispositivos del producto a IoT Platform, especifique este parámetro. Valores válidos: modbus: Modbus. opc-ua: Open Platform Communication Unified Architecture (OPC UA). customize: protocolo personalizado. ble: Bluetooth Low Energy (BLE). zigbee: ZigBee.
NetType	String	No	WIFI	El método de conexión de red. Este parámetro es obligatorio si los dispositivos del producto son puertas de enlace o dispositivos de conexión directa. Valores válidos: WIFI CELLULAR ETHERNET OTHER Valor predeterminado: WIFI.
JoinPermissionId	String	No	8***	No es necesario especificar este parámetro.
ResourceGroupId	String	No	rg-acfmxazb4ph***	El ID del resource group. Importante IoT Platform permite gestionar únicamente recursos de instancia mediante resource groups. ResourceGroupId no surte efecto en esta solicitud. No es necesario especificar este parámetro. Los resource groups que configuró en solicitudes anteriores mediante esta operación de API siguen siendo válidos.
AuthType	String	No	secret	El método de autenticación utilizado para conectar los dispositivos del producto a IoT Platform. No es necesario especificar este parámetro. Se utiliza automáticamente el valor predeterminado secret. Para obtener más información, consulte Establecimiento de conexiones MQTT sobre TCP.
CategoryKey	String	No	Lighting	El identificador de la categoría del producto. Si especifica este parámetro, se utiliza un modelo TSL de la categoría del producto. De lo contrario, no se utiliza ningún modelo TSL. Llame a la operación ListThingTemplates para consultar los detalles de las categorías de productos predefinidas por IoT Platform y obtener las claves de categoría.
PublishAuto	Boolean	No	false	Especifica si se publica el modelo TSL después de crear el producto. Valores válidos: true false Valor predeterminado: true.
ValidateType	Integer	No	1	El nivel de verificación de datos. De forma predeterminada, si no especifica este parámetro, se realiza una verificación débil. Valores válidos: 1: verificación débil. IoT Platform verifica únicamente los campos identifier y dataType de los datos. Todos los datos se reenvían. 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. Consulte los datos que no superaron la verificación en el parámetro checkFailedData de los datos reenviados. Para obtener más información, consulte Formatos de datos. 2: sin verificación. IoT Platform no verifica los datos. Todos los datos 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.

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 Parámetros comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	200	El código de error devuelto si la solicitud falló. Para obtener más información, consulte Códigos de error.
Data	Struct		La información del producto devuelta si la solicitud se realiza correctamente.
AliyunCommodityCode	String	iothub_senior	Indica si se utiliza un modelo TSL para el producto. Valores válidos: iothub_senior: se utiliza un modelo TSL. iothub: no se utiliza ningún modelo TSL.
AuthType	String	secret	El método de autenticación utilizado para conectar los dispositivos del producto a IoT Platform.
DataFormat	Integer	1	El formato de datos. Valores válidos: 0: formato de datos personalizado. 1: formato Alink JSON. Nota Este parámetro se devuelve únicamente cuando AliyunCommodityCode está establecido en iothub_senior.
Description	String	Prueba de producto	La descripción del producto.
Id2	Boolean	false	Indica si la autenticación basada en ID² está habilitada. Valores válidos: true false
NodeType	Integer	0	El tipo de nodo del producto. Valores válidos: 0: dispositivo. No se pueden conectar subdispositivos a un dispositivo. Un dispositivo puede conectarse directamente a IoT Platform o como subdispositivo de una puerta de enlace. 1: puerta de enlace. Se pueden conectar 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. Nota Este parámetro se devuelve únicamente cuando AliyunCommodityCode está establecido en iothub_senior.
ProductKey	String	a1FlqIQ****	La ProductKey del producto. Una ProductKey es un GUID emitido por IoT Platform para un producto. Nota Mantenga la ProductKey confidencial. La ProductKey es necesaria al realizar ciertas operaciones.
ProductName	String	Test	El nombre del producto.
ProductSecret	String	U5tW7i44uilc****	La ProductSecret del producto.
ProtocolType	String	modbus	El protocolo que utilizan los dispositivos del producto para conectarse a la puerta de enlace. Nota Este parámetro se devuelve únicamente cuando AliyunCommodityCode está establecido en iothub_senior.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la solicitud falló.
ProductKey	String	a1FlqIQ****	La ProductKey del producto. Una ProductKey es un GUID emitido por IoT Platform para un producto.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	El ID de la solicitud.
Success	Boolean	true	Indica si la solicitud se realizó correctamente. Valores válidos: true false

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=CreateProduct
&AliyunCommodityCode=iothub_senior
&AuthType=secret
&DataFormat=1
&Description=Product test
&NodeType=0
&ResourceGroupId=rg-acfmxazb4ph****
&ProductName=Test
&ProtocolType=modbus
&CategoryKey=Lighting
&PublishAuto=false
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<CreateProductResponse>
      <Data>
            <Description>Product test</Description>
            <DataFormat>1</DataFormat>
            <ProtocolType>modbus</ProtocolType>
            <ProductKey>a1FlqIQ****</ProductKey>
            <ProductSecret>U5tW7i44uilc****</ProductSecret>
            <NodeType>0</NodeType>
            <ProductName>Test</ProductName>
            <AliyunCommodityCode>iothub_senior</AliyunCommodityCode>
            <AuthType>secret</AuthType>
            <ResourceGroupId>rg-acfmxazb4ph****</ResourceGroupId>
      </Data>
      <ProductKey>a1FlqIQ****</ProductKey>
      <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
      <Success>true</Success>
</CreateProductResponse>

Formato JSON

{
  "Data": {
    "Description": "Product test",
    "DataFormat": 1,
    "ProtocolType": "modbus",
    "ProductKey": "a1FlqIQ****",
    "ProductSecret": "U5tW7i44uilc****",
    "NodeType": 0,
    "ProductName": "Test",
    "AliyunCommodityCode": "iothub_senior",
    "AuthType": "secret",
    "ResourceGroupId": "rg-acfmxazb4ph****"
  },
  "ProductKey": "a1FlqIQ****",
  "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
  "Success": true
}

Códigos de error

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