GetThingModelTsl - IoT Platform - Centre de documentation Alibaba Cloud

Interroge le modèle Thing Specification Language (TSL) d'un produit.

Limites

Chaque compte Alibaba Cloud peut exécuter un maximum de 20 requêtes par seconde (QPS).

Remarque

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

Débogage

Alibaba Cloud met à votre disposition OpenAPI Explorer pour simplifier l'utilisation des API. 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 l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	GetThingModelTsl	Opération à effectuer. Définissez la valeur sur GetThingModelTsl.
IotInstanceId	String	No	iot_instc_pu*_c-v64	ID de l'instance. Vous pouvez consulter l'ID de l'instance sur la page Overview de la console IoT Platform. Important Si votre instance possède un ID, vous devez configurer ce paramètre. Sinon, l'appel échoue. Si votre instance ne possède pas de page Overview ou d'ID, inutile de définir ce paramètre. Pour plus d'informations, consultez Overview.
ProductKey	String	No	a1BwAGV****	ProductKey du produit. Vous pouvez consulter le ProductKey sur la page Product Details de la console IoT Platform. Vous pouvez également obtenir le ProductKey en appelant l'opération QueryProductList.
ModelVersion	String	No	v1.0.0	Numéro de version du modèle TSL à interroger. Si vous ne spécifiez pas ce paramètre, IoT Platform renvoie le brouillon du modèle TSL non publié.
Simple	Boolean	No	true	Indique s'il faut récupérer un modèle TSL simplifié. true : récupère un modèle TSL simplifié. Un modèle TSL simplifié inclut uniquement les attributs identifier et dataType des propriétés, des services, des événements et des paramètres d'entrée ou de sortie associés. Les développeurs de périphériques peuvent utiliser les modèles TSL simplifiés à titre de référence. false : récupère le modèle TSL complet. Un modèle TSL complet inclut tous les paramètres et valeurs des propriétés, des services et des événements. Les développeurs d'applications cloud peuvent utiliser les modèles TSL complets à titre de référence. Valeur par défaut : false.
FunctionBlockId	String	No	BatteryModule	Identifiant du module TSL personnalisé. Chaque identifiant est unique au sein d'un produit. Si vous ne spécifiez pas ce paramètre, le module par défaut est interrogé.

Outre les paramètres de requête spécifiques à l'opération, vous devez spécifier les paramètres de requête communs lors de l'appel de cette opération. Pour plus d'informations, consultez Common request parameters.

Paramètres de réponse

Parameter	Type	Example	Description
Code	String	iot.system.SystemException	Code d'erreur renvoyé en cas d'échec de l'appel. Pour plus d'informations, consultez Error codes.
Data	Struct		Données TSL renvoyées en cas de réussite de l'appel.
TslStr	String	{\"schema\":\"https://iotx-tsl.oss-ap-southeast-1.aliyuncs.com/schema.json\",\"profile\":{\"productKey\":\"a14TeWI****\"},\"properties\":[{\"identifier\":\"Humidity\"}]}	Chaîne du modèle TSL.
TslUri	String	https://iotx-pop-dsl.oss-cn-shanghai.aliyuncs.com/thing/a14T/model.json?Expires=1581947119&OSSAccessKeyId=LTAI&Signature=5i38	URI utilisé pour stocker les données TSL dans Object Storage Service (OSS). L'URI est valide pendant 60 minutes.
ErrorMessage	String	A system exception occurred.	Message d'erreur renvoyé en cas d'échec de l'appel.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	ID de la requête.
Success	Boolean	true	Indique si l'appel a réussi. true : l'appel a réussi. false : l'appel a échoué.

Exemples

Exemples de requêtes

https://iot.cn-shanghai.aliyuncs.com/?Action=GetThingModelTsl
&ProductKey=a1bPo9p****
&ModelVersion=v1.0.0
&Simple=false
&<Common request parameters>

Exemples de réponses réussies

Format XML

<GetThingModelTslResponse>
  <Data>
        <TslUri>https://iotx-pop-dsl.oss-cn-shanghai.aliyuncs.com/thing/a14T******/model.json?Expires=1581947119&OSSAccessKeyId=LTAI****************&Signature=5i38******</TslUri>
        <TslStr>{"schema":"https://iotx-tsl.oss-ap-southeast-1.aliyuncs.com/schema.json","profile":{"productKey":"a14***"},"properties":[{"identifier":"Humidity","name":"Humidity","accessMode":"rw","required":false,"dataType":{"type":"int","specs":{"min":"55","max":"60","unit":"%","step":"1"}}},{"identifier":"Temperature","name":"Temperature","accessMode":"rw","required":false,"dataType":{"type":"float","specs":{"min":"26","max":"28","unit":"°C","step":"0.01"}}}],"events":[{"identifier":"post","name":"post","type":"info","required":true,"desc":"Submit properties","method":"thing.event.property.post","outputData":[{"identifier":"Humidity","name":"Humidity","dataType":{"type":"int","specs":{"min":"55","max":"60","unit":"%","step":"1"}}},{"identifier":"Temperature","name":"Temperature","dataType":{"type":"float","specs":{"min":"26","max":"28","unit":"°C","step":"0.01"}}}]}],"services":[{"identifier":"set","name":"set","required":true,"callType":"async","desc":"Set properties","method":"thing.service.property.set","inputData":[{"identifier":"Humidity","name":"Humidity","dataType":{"type":"int","specs":{"min":"55","max":"60","unit":"%","step":"1"}}},{"identifier":"Temperature","name":"Temperature","dataType":{"type":"float","specs":{"min":"26","max":"28","unit":"°C","step":"0.01"}}}],"outputData":[]},{"identifier":"get","name":"get","required":true,"callType":"async","desc":"Obtain properties","method":"thing.service.property.get","inputData":["Humidity","Temperature"],"outputData":[{"identifier":"Humidity","name":"Humidity","dataType":{"type":"int","specs":{"min":"55","max":"60","unit":"%","step":"1"}}},{"identifier":"Temperature","name":"Temperature","dataType":{"type":"float","specs":{"min":"26","max":"28","unit":"°C","step":"0.01"}}}]}]}</TslStr>
  </Data>
  <RequestId>C4371E68-F6DB-4D7B-8AD0-D38336E1DF94</RequestId>
  <Success>true</Success>
</GetThingModelTslResponse>

Format JSON

{
    "Data": {
        "TslUri": "https://iotx-pop-dsl.oss-cn-shanghai.aliyuncs.com/thing/a14T******/model.json?Expires=1581947119&OSSAccessKeyId=LTAI****************&Signature=5i38******",
        "TslStr": "{\"schema\":\"https://iotx-tsl.oss-ap-southeast-1.aliyuncs.com/schema.json \",\" profile\":[\"productKey\":\"a14*** \",\" properties\":[{\"identifier\":\"Humidity\",\"name\":\"Humidity\",\" accessMode\":\"rw\",\"required\":false,\"dataType\":{\"type\":\"int\",\"specs\":{\"min\":\"55\",\"max\":\"60\",\"unit\":\"%\",\"step\":\" 1\"****** \"identifier\":\"Temperature\",\"name\":\"Temperature\",\"accessMode\":\"rw\",\"required\":false,\"dataType\":[\"type\": \"float\",\"specs\":{\"min\":\"26\",\"max\":\"28\",\"unit\":\"°C\",\"step\":\"0.01\"}}}],\"events\": [{\"identifier\":\"post\",\"name\":\"post\",\"type\":\"info\",\"required\":true,\"desc\":\"Submit properties reporting \",\"method\":\"thing.event.property.post\", \"outputData\":[{\"identifier\":\"Humidity\",\"name\":\"Humidity\",\"dataType\" :%\ "type\":\"int\",\"specs\" :%\ "min":\"55\", \"max\":\"60\",\"unit\":\"%\",\"step\":\"1\" ****** \"identifier\":\"Temperature\",\"name\":\"Temperature\",\"dataType\": {\"type\":\"float\",\"specs\":{\"min\":\"26\",\"max\":\"28\",\"unit\":\"°C\",\"step\":\"0.01\"}}}] }],\"services\":[{\"identifier\":\"set\",\"name\":\"set\",\"required\":true,\"callType\":\"async\",\"desc\":\"Set properties\",\" method\":\"thing.service.property.set\",\" inputData\":[{\"identifier\":\"Humidity\",\"name\":\" Humidity\",\"dataType\":\"type\":\"int\",\" specs\":\" min\":\"55\",\"max\":\"60\",\"unit\":\"%\",\"step\":\"1\"}}},{\"identifier\":\"Temperature\",\"name\":\" Temperature \",\"dataType\":[\"type\":\"float\",\" specs\":[\"min\":\"26\",\" max\":\"28\",\"unit\":\"°C\",\"step\": \"0.01\"}}}],\"outputData\":[]},{\"identifier\":\"get\",\"name\":\"get\",\"required\":true,\"callType\":\"async\",\"desc\":\"Obtain properties\",\"method\":\"thing.service.property.get\",\"inputData\":[\"Humidity\",\"Temperature\"],\"outputData\":[{\"identifier\":\"Humidity\",\"name\":\"Humidity \", \"dataType\":{\"type\":\"int\",\"specs\":{\"min\":\"55\",\"max\":\"60\",\"unit\":\"%\",\"step\":\" 1\"****** \"identifier\":\"Temperature\",\"name\":\"Temperature\",\"dataType\":\\"type\":\"float\",\"specs\":[\"min ":\"26\", \"max\":\"28\",\"unit\":\"°C\",\"step\":\"0.01\"}}}]}]}"
    },
    "RequestId": "C4371E68-F6DB-4D7B-8AD0-D38336E1DF94",
    "Success": true
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, visitez le API Error Center.