Importe un modèle Thing Specification Language (TSL) dans un produit.
Notes d'utilisation
Si le produit cible de l'opération ImportThingModelTsl est publié, vous devez d'abord appeler l'opération CancelReleaseProduct pour le dépublier avant d'exécuter ImportThingModelTsl.
Limites QPS
Vous pouvez appeler cette opération jusqu'à cinq fois par seconde par compte.
Les utilisateurs Resource Access Management (RAM) d'un compte Alibaba Cloud partagent le quota de ce compte.
Débogage
Paramètres de requête
Parameter | Type | Required | Example | Description |
Action | String | Yes | ImportThingModelTsl | Opération à effectuer. Définissez la valeur sur ImportThingModelTsl. |
ProductKey | String | Yes | a1BwAGV**** | Clé ProductKey du produit. Consultez la clé ProductKey sur la page Products de la console IoT Platform. Vous pouvez également appeler l'opération QueryProductList pour récupérer la clé ProductKey. |
IotInstanceId | String | No | iot_instc_pu**_c-v64* | ID de l'instance. Consultez l'ID de l'instance sous l'onglet Overview de la console IoT Platform. Important
Pour en savoir plus sur les instances, consultez la rubrique Overview. |
ResourceGroupId | String | No | rg-acfm4l5tcwd**** | ID du groupe de ressources. Important IoT Platform prend uniquement en charge la gestion des ressources par instance. Le paramètre ResourceGroupId est obsolète. Ne le spécifiez pas. |
TslStr | String | No | {"schema":"https://iotx-tsl.oss-ap-southeast-1.aliyuncs.com/schema.json","profile":{"productKey":"a14TeW****"},"properties":[]} | Modèle TSL à importer, sous forme de chaîne JSON. Le modèle TSL définit les propriétés, les services et les événements du produit. La valeur de TslStr doit respecter le format de données TSL standard. Pour plus d'informations, consultez la rubrique What is a TSL model? Remarque Pour importer un modèle TSL, spécifiez le paramètre TslStr. |
TslUrl | String | No | https://iotx-pop-dsl.oss-cn-shanghai.aliyuncs.com/thing/a14TeWI****/model.json?Expires=1581947119... | URI du fichier de modèle TSL stocké dans Object Storage Service (OSS). Remarque Ce paramètre est inopérant. Pour importer un modèle TSL, spécifiez le paramètre TslStr. |
FunctionBlockId | String | No | BatteryModule | Identifiant du module TSL personnalisé. Chaque identifiant doit être unique au sein d'un produit. Il doit contenir entre 1 et 30 caractères (lettres, chiffres et traits de soulignement _). Utilisez ce paramètre conjointement avec FunctionBlockName. À défaut, le système importe le module par défaut. |
FunctionBlockName | String | No | BatteryModule | Nom du module TSL personnalisé. Il doit contenir entre 4 et 30 caractères (lettres, chiffres et traits de soulignement _). Utilisez ce paramètre conjointement avec FunctionBlockId. À défaut, le système importe le module par défaut. |
Outre les paramètres spécifiques à l'opération, vous devez indiquer les paramètres de requête communs lors de l'appel de cette opération. Pour plus d'informations, consultez la rubrique Paramètres communs.
Paramètres de réponse
Parameter | Type | Example | Description |
Code | String | iot.system.SystemException | Code d'erreur renvoyé en cas d'échec de la requête. Pour plus d'informations, consultez la rubrique Codes d'erreur. |
ErrorMessage | String | A system exception occurred. | Message d'erreur renvoyé en cas d'échec de la requête. |
RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | ID de la requête. |
Success | Boolean | true | Indique si la requête a abouti. Valeurs possibles :
|
Exemples
Exemple de requête
https://iot.cn-shanghai.aliyuncs.com/?Action=ImportThingModelTsl
&ProductKey=a1lWSUw****
&TslStr={\"profile\":{\"productKey\": \"a1bPo9p****\"},\"services\":[],\"properties\":[],\"events\":[]}
&<Common request parameters>
Exemple de réponse réussie
Format XML
<ImportThingModelTslResponse>
<RequestId>9E76053E-26ED-4AB4-AE58-8AFC3F1E7E8E</RequestId>
<Success>true</Success>
</ImportThingModelTslResponse>
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.