DeleteThingModel - IoT Platform - Centre de documentation Alibaba Cloud

Supprime une ou plusieurs fonctionnalités du langage de spécification des objets (TSL) d'un produit. Les fonctionnalités peuvent être des propriétés, des services ou des événements.

Notes d'utilisation

Si un produit est publié, vous devez appeler l'opération CancelReleaseProduct pour annuler sa publication avant d'appeler l'opération DeleteThingModel.
Si une nouvelle fonctionnalité ou un module TSL personnalisé d'un produit n'est pas publié, vous pouvez appeler l'opération DeleteThingModel pour supprimer cette fonctionnalité ou ce module TSL personnalisé.
Lorsque vous appelez l'opération DeleteThingModel, vous devez spécifier le paramètre ProductKey et au moins l'un des paramètres suivants : FunctionBlockId, PropertyIdentifier.N, ServiceIdentifier.N et EventIdentifier.N. La liste suivante décrit le fonctionnement de l'opération DeleteThingModel :
- Si vous ne spécifiez que les paramètres ProductKey et FunctionBlockId, l'opération supprime le module TSL personnalisé indiqué du produit spécifié.
- Si vous spécifiez le paramètre ProductKey ainsi que le paramètre PropertyIdentifier.N, ServiceIdentifier.N ou EventIdentifier.N, l'opération supprime une ou plusieurs fonctionnalités spécifiées du module TSL par défaut du produit indiqué. La suppression n'a lieu que si les fonctionnalités existent. Si les identifiants de fonctionnalité que vous avez spécifiés dans les paramètres PropertyIdentifier.N, ServiceIdentifier.N et EventIdentifier.N sont absents du module TSL par défaut, l'opération renvoie un message d'erreur indiquant que les fonctionnalités spécifiées sont introuvables.
- Si vous spécifiez les paramètres ProductKey et FunctionBlockId ainsi que le paramètre PropertyIdentifier.N, ServiceIdentifier.N ou EventIdentifier.N, l'opération supprime une ou plusieurs fonctionnalités spécifiées du module TSL personnalisé indiqué dans le produit spécifié. La suppression n'a lieu que si les fonctionnalités existent. Si les identifiants de fonctionnalité que vous avez spécifiés dans les paramètres PropertyIdentifier.N, ServiceIdentifier.N et EventIdentifier.N sont absents du module TSL personnalisé, l'opération renvoie un message d'erreur indiquant que les fonctionnalités spécifiées sont introuvables.
  
  Remarque
  Vous pouvez spécifier jusqu'à 10 identifiants de fonctionnalité dans le paramètre PropertyIdentifier.N, ServiceIdentifier.N ou EventIdentifier.N.
Après avoir appelé l'opération DeleteThingModel pour supprimer une ou plusieurs fonctionnalités d'un produit, vous devez appeler l'opération PublishThingModel pour republier le modèle TSL du produit. Cette étape permet d'appliquer la modification.

Limites QPS

Vous pouvez appeler cette opération d'API jusqu'à cinq fois par seconde par compte.

Remarque

Les utilisateurs RAM d'un compte Alibaba Cloud partagent le quota du compte.

Débogage

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

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	DeleteThingModel	L'opération à effectuer. Définissez la valeur sur DeleteThingModel.
IotInstanceId	String	No	iot-cn-0pp1n8t****	L'ID d'instance. Vous pouvez consulter l'ID de l'instance dans l'onglet Overview de la console IoT Platform. Important Si l'instance possède un ID, vous devez spécifier ce paramètre. À défaut, la requête échoue. Si l'onglet Overview ou l'ID de l'instance n'est pas affiché dans la console IoT Platform, vous n'avez pas besoin de spécifier ce paramètre. Pour en savoir plus sur les instances, consultez la rubrique Vue d'ensemble.
FunctionBlockId	String	No	BatteryModule	L'identifiant du module TSL personnalisé. Chaque identifiant est unique au sein d'un produit. Si vous spécifiez le paramètre FunctionBlockId en même temps que le paramètre PropertyIdentifier.N, ServiceIdentifier.N ou EventIdentifier.N, l'opération supprime une ou plusieurs fonctionnalités spécifiées du module TSL personnalisé indiqué. Si vous ne spécifiez pas le paramètre FunctionBlockId, l'opération supprime une ou plusieurs fonctionnalités spécifiées du module TSL par défaut. Si vous spécifiez le paramètre FunctionBlockId sans spécifier les paramètres PropertyIdentifier.N, ServiceIdentifier.N et EventIdentifier.N, l'opération supprime le module TSL personnalisé indiqué ainsi que toutes les fonctionnalités qu'il contient.
ProductKey	String	No	a1BwAGV****	La ProductKey du produit.
PropertyIdentifier.N	RepeatList	No	Temperature	Les identifiants des propriétés à supprimer. Vous pouvez spécifier jusqu'à 10 identifiants de propriété.
ServiceIdentifier.N	RepeatList	No	Set	Les identifiants des services à supprimer. Vous pouvez spécifier jusqu'à 10 identifiants de service.
EventIdentifier.N	RepeatList	No	OfflineAlert	Les identifiants des événements à supprimer. Vous pouvez spécifier jusqu'à 10 identifiants d'événement.
ResourceGroupId	String	No	rg-acfm4l5tcwd****	L'identifiant du groupe de ressources. Important IoT Platform prend en charge la gestion des groupes de ressources uniquement par instance. Le paramètre ResourceGroupId n'est pas valide. Vous n'avez pas besoin de spécifier ce paramètre.

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

Paramètres de réponse

Parameter	Type	Example	Description
Code	String	iot.system.SystemException	Le code d'erreur renvoyé en cas d'échec de la requête. Pour plus d'informations sur les codes d'erreur, consultez la rubrique Codes d'erreur.
ErrorMessage	String	A system exception occurred.	Le message d'erreur renvoyé en cas d'échec de la requête.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	L'identifiant de la requête.
Success	Boolean	true	Indique si la requête a abouti. Valeurs possibles : true false

Exemples

Exemple de requête

https://iot.cn-shanghai.aliyuncs.com/?Action=DeleteThingModel
&ProductKeySource=a1rYuVF****
&PropertyIdentifier.1=speed
&ServiceIdentifier.1=SetSpeed
&EventIdentifier.1=SpeedAlarm
&<Common request parameters>

Exemple de réponse en cas de succès

Format XML

<DeleteThingModelResponse>
  <RequestId>9E76053E-26ED-4AB4-AE58-8AFC3F1E7E8E</RequestId>
  <Success>true</Success>
</DeleteThingModelResponse>

Format JSON

{
  "RequestId": "9E76053E-26ED-4AB4-AE58-8AFC3F1E7E8E",
  "Success": true
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez la rubrique Codes d'erreur de service .