GetThingModelTslPublished - IoT Platform - Centre de documentation Alibaba Cloud

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

Limites de QPS

Vous pouvez appeler cette opération jusqu'à 20 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. 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

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	GetThingModelTslPublished	L'opération que vous souhaitez effectuer. Définissez la valeur sur GetThingModelTslPublished.
ProductKey	String	Oui	a1BwAGV****	La ProductKey du produit.
IotInstanceId	String	Non	iot-cn-0pp1n8t****	L'ID de l'instance. Vous pouvez consulter l'ID d'instance sur la page Aperçu de la console IoT Platform. Important Si votre instance possède un ID, vous devez spécifier ce paramètre. Sinon, la requête échoue. Si la page Aperçu 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 la rubrique Aperçu.
ResourceGroupId	String	Non	rg-acfm4l5tcwd****	L'ID du groupe de ressources. Important IoT Platform vous permet de gérer uniquement les instances par groupe de ressources. Le paramètre ResourceGroupId ne prend pas effet. Vous n'avez pas besoin de spécifier ce paramètre.
Simple	Boolean	Non	true	Indique s'il faut renvoyer un modèle TSL simplifié. Valeurs valides : true : renvoie un modèle TSL simplifié. Un modèle TSL simplifié définit uniquement les propriétés, services et événements de l'appareil, ainsi que l'identifiant et le type de données des paramètres d'entrée et de sortie. Les modèles TSL simplifiés peuvent servir de référence aux développeurs d'appareils. false (par défaut) : renvoie un modèle TSL complet. Un modèle TSL complet définit les propriétés, services et événements de l'appareil, ainsi que tous les paramètres et valeurs. Les modèles TSL complets peuvent servir de référence aux développeurs d'applications cloud.
ModelVersion	String	Non	v1.0.0	Le numéro de version du modèle TSL. Vous pouvez appeler l'opération ListThingModelVersion pour interroger le numéro de version du modèle TSL d'un produit. Si vous ne spécifiez pas ce paramètre, la dernière version publiée du modèle TSL est utilisée.
FunctionBlockId	String	Non	BatteryModule	L'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 utilisé.

En plus des paramètres de requête spécifiques à l'opération précédents, vous devez spécifier 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 la rubrique Paramètres communs.

Paramètres de réponse

Paramètre	Type	Exemple	Description
Code	String	iot.system.SystemException	Le code d'erreur renvoyé en cas d'échec de la requête. Pour plus d'informations, consultez la rubrique Codes d'erreur.
Data	Struct		Les données renvoyées.
TslStr	String	{\"schema\":\"https://iotx-tsl.oss-ap-southeast-1.aliyuncs.com/schema.json\",\"profile\":{\"productKey\":\"a14TeWI****\"},\"properties\":[{\"identifier\":\"Humidity\"}]}	La 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	L'URI (Uniform Resource Identifier) des données TSL stockées dans Object Storage Service (OSS). La période de validité de l'URI est de 60 minutes.
ErrorMessage	String	Une exception système s'est produite.	Le message d'erreur renvoyé en cas d'échec de la requête.
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 valides : true false

Exemples

Exemples de requêtes

https://iot.cn-shanghai.aliyuncs.com/?Action=GetThingModelTslPublished
&ProductKey=a1BwAGV****
&<Common request parameters>

Exemples de réponses réussies

Format XML

<GetThingModelTslPublishedResponse>
    <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":"a14TeWI****"},"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":"Query 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>
</GetThingModelTslPublishedResponse>

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\":\"a14TeWI****\"},\"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\":\"Query 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, consultez la rubrique Codes d'erreur de service.