CreateProduct - IoT Platform - Centre de documentation Alibaba Cloud

Crée un produit.

Remarques d'utilisation

Si un modèle Thing Specification Language (TSL) est requis pour créer un produit, définissez le paramètre AliyunCommodityCode sur iothub_senior et spécifiez le paramètre DataFormat. Pour plus d'informations, consultez la section Request parameters de cette rubrique.

Limites QPS

Vous pouvez appeler cette opération jusqu'à 50 fois par seconde par compte.

Remarque

Les utilisateurs Resource Access Management (RAM) d'un compte Alibaba Cloud partagent le quota du compte.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Par commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	CreateProduct	L'opération à effectuer. Définissez la valeur sur CreateProduct.
NodeType	Integer	Yes	0	Le type de nœud du produit. Valeurs possibles : 0 : appareil. Les sous-appareils ne peuvent pas être attachés à un appareil. Un appareil peut être connecté directement à IoT Platform ou connecté à IoT Platform en tant que sous-appareil d'une passerelle. Si vous utilisez l'appareil comme sous-appareil d'une passerelle, spécifiez ProtocolType. 1 : passerelle. Les sous-appareils peuvent être attachés à une passerelle. Une passerelle peut gérer les sous-appareils, maintenir les relations topologiques avec les sous-appareils et synchroniser les relations topologiques avec IoT Platform.
ProductName	String	Yes	Light	Le nom du produit. Le nom doit comporter entre 4 et 30 caractères et peut contenir des lettres, des chiffres et des traits de soulignement (_). Chaque caractère chinois compte pour deux caractères. Important Chaque nom de produit doit être unique au sein de l'instance actuelle.
IotInstanceId	String	No	iot-*-v64*	L'ID de l'instance. Vous pouvez afficher l'ID de l'instance sur la page Overview de la console IoT Platform. Important Si votre instance possède un ID, spécifiez ce paramètre. Sinon, la requête échoue. Si la page Overview ou l'ID d'instance n'est pas affiché dans la console IoT Platform, vous n'avez pas besoin de spécifier ce paramètre. Pour plus d'informations, consultez Vue d'ensemble.
DataFormat	Integer	No	1	Le format des données. Valeurs possibles : 0 : format de données personnalisé. 1 : format Alink JSON.
Description	String	No	Product test	La description du produit. La description peut comporter jusqu'à 100 caractères.
AliyunCommodityCode	String	No	iothub_senior	L'édition du produit. Par défaut, si vous ne spécifiez pas ce paramètre, un produit de l'édition Basic est automatiquement créé. Vous ne pouvez pas utiliser un modèle TSL pour définir le produit. Si vous souhaitez spécifier ce paramètre, définissez la valeur sur iothub_senior. Dans ce cas, un produit prenant en charge les modèles TSL est créé. Spécifiez également le paramètre DataFormat. Important Pour les produits de l'édition Basic, vous ne pouvez pas utiliser la fonctionnalité débogage en ligne dans la console IoT Platform.
Id2	Boolean	No	false	Vous n'avez pas besoin de spécifier ce paramètre.
ProtocolType	String	No	modbus	Le protocole utilisé par les appareils du produit pour se connecter à la passerelle. Si AliyunCommodityCode est défini sur iothub_senior et qu'une passerelle est requise pour connecter les appareils du produit à IoT Platform, spécifiez ce paramètre. Valeurs possibles : modbus : Modbus. opc-ua : Open Platform Communication Unified Architecture (OPC UA). customize : protocole personnalisé. ble : Bluetooth Low Energy (BLE). zigbee : ZigBee.
NetType	String	No	WIFI	La méthode de connexion réseau. Ce paramètre est requis si les appareils des produits sont des passerelles ou des appareils connectés directement. Valeurs possibles : WIFI CELLULAR ETHERNET OTHER Valeur par défaut : WIFI.
JoinPermissionId	String	No	8***	Vous n'avez pas besoin de spécifier ce paramètre.
ResourceGroupId	String	No	rg-acfmxazb4ph***	L'ID du groupe de ressources. Important IoT Platform vous permet de gérer uniquement les ressources d'instance par groupes de ressources. ResourceGroupId ne prend pas effet dans cette requête. Vous n'avez pas besoin de spécifier ce paramètre. Les groupes de ressources configurés dans les requêtes historiques à l'aide de cette opération API restent valides.
AuthType	String	No	secret	La méthode d'authentification utilisée pour connecter les appareils du produit à IoT Platform. Vous n'avez pas besoin de spécifier ce paramètre. La valeur par défaut secret est automatiquement utilisée. Pour plus d'informations, consultez Établissement de connexions MQTT via TCP.
CategoryKey	String	No	Lighting	L'identifiant de la catégorie de produit. Si vous spécifiez ce paramètre, un modèle TSL de la catégorie de produit est utilisé. Sinon, aucun modèle TSL n'est utilisé. Appelez l'opération ListThingTemplates pour interroger les détails des catégories de produits prédéfinies par IoT Platform et obtenir les clés de catégorie.
PublishAuto	Boolean	No	false	Indique s'il faut publier le modèle TSL après la création du produit. Valeurs possibles : true false Valeur par défaut : true.
ValidateType	Integer	No	1	Le niveau de vérification des données. Par défaut, si vous ne spécifiez pas ce paramètre, une vérification faible est effectuée. Valeurs possibles : 1 : vérification faible. IoT Platform vérifie uniquement les champs identifier et dataType des données. Toutes les données sont transférées. Dans la console IoT Platform, les données sont affichées dans l'onglet TSL Data de la page Device Details. Les données qui échouent à la vérification ne sont pas affichées. Vous pouvez afficher les données ayant échoué à la vérification dans le paramètre checkFailedData des données transférées. Pour plus d'informations, consultez Formats de données. 2 : aucune vérification. IoT Platform ne vérifie pas les données. Toutes les données sont transférées. Dans la console IoT Platform, les données ne sont pas affichées dans l'onglet TSL Data de la page Device Details.

En plus des paramètres de requête spécifiques à l'opération ci-dessus, configurez les paramètres de requête communs lors de l'appel de cette opération. Pour plus d'informations sur les paramètres de requête communs, consultez Paramètres communs.

Response parameters

Parameter	Type	Example	Description
Code	String	200	Le code d'erreur renvoyé si la requête a échoué. Pour plus d'informations, consultez Codes d'erreur.
Data	Struct		Les informations sur le produit renvoyées si la requête réussit.
AliyunCommodityCode	String	iothub_senior	Indique si un modèle TSL est utilisé pour le produit. Valeurs possibles : iothub_senior : un modèle TSL est utilisé. iothub : aucun modèle TSL n'est utilisé.
AuthType	String	secret	La méthode d'authentification utilisée pour connecter les appareils du produit à IoT Platform.
DataFormat	Integer	1	Le format des données. Valeurs possibles : 0 : format de données personnalisé. 1 : format Alink JSON. Remarque Ce paramètre est renvoyé uniquement lorsque AliyunCommodityCode est défini sur iothub_senior.
Description	String	Product test	La description du produit.
Id2	Boolean	false	Indique si l'authentification basée sur ID² est activée. Valeurs possibles : true false
NodeType	Integer	0	Le type de nœud du produit. Valeurs possibles : 0 : appareil. Les sous-appareils ne peuvent pas être attachés à un appareil. Un appareil peut être connecté directement à IoT Platform ou connecté à IoT Platform en tant que sous-appareil d'une passerelle. 1 : passerelle. Les sous-appareils peuvent être attachés à une passerelle. Une passerelle peut gérer les sous-appareils, maintenir les relations topologiques avec les sous-appareils et synchroniser les relations topologiques avec IoT Platform. Remarque Ce paramètre est renvoyé uniquement lorsque AliyunCommodityCode est défini sur iothub_senior.
ProductKey	String	a1FlqIQ****	La ProductKey du produit. Une ProductKey est un GUID émis par IoT Platform pour un produit. Remarque Gardez la ProductKey confidentielle. La ProductKey est requise lors de l'exécution de certaines opérations.
ProductName	String	Test	Le nom du produit.
ProductSecret	String	U5tW7i44uilc****	La ProductSecret du produit.
ProtocolType	String	modbus	Le protocole utilisé par les appareils du produit pour se connecter à la passerelle. Remarque Ce paramètre est renvoyé uniquement lorsque AliyunCommodityCode est défini sur iothub_senior.
ErrorMessage	String	A system exception occurred.	Le message d'erreur renvoyé si la requête a échoué.
ProductKey	String	a1FlqIQ****	La ProductKey du produit. Une ProductKey est un GUID émis par IoT Platform pour un produit.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	L'ID de la requête.
Success	Boolean	true	Indique si la requête a réussi. Valeurs possibles : true false

Exemples

Exemple de requêtes

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>

Exemple de réponses réussies

XML format

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

JSON format

{
  "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
}

Codes d'erreur

Pour une liste des codes d'erreur, consultez Codes d'erreur de service.