GetThingModelTsl - IoT Platform - Centro de documentación de Alibaba Cloud

Consulta el modelo Thing Specification Language (TSL) de un producto.

Límites

Cada cuenta de Alibaba Cloud puede ejecutar un máximo de 20 consultas por segundo (QPS).

Nota

Los usuarios de RAM de una cuenta de Alibaba Cloud comparten la cuota de dicha cuenta.

Depuración

Alibaba Cloud proporciona OpenAPI Explorer para simplificar el uso de las API. OpenAPI Explorer calcula automáticamente el valor de la firma. Para mayor comodidad, se recomienda invocar esta operación en OpenAPI Explorer. Esta herramienta genera dinámicamente el código de ejemplo de la operación para distintos SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	GetThingModelTsl	La operación que desea ejecutar. Establezca el valor en GetThingModelTsl.
IotInstanceId	String	No	iot_instc_pu*_c-v64	El identificador de la instancia. Consulte el ID de la instancia en la página Descripción general de la consola de IoT Platform. Importante Si su instancia tiene un identificador, debe configurar este parámetro. De lo contrario, la llamada finaliza con errores. Si su instancia no tiene página Descripción general ni identificador, no es necesario configurar este parámetro. Para obtener más información, consulte Descripción general.
ProductKey	String	No	a1BwAGV****	El ProductKey del producto. Consulte el ProductKey en la página Product Details de la consola de IoT Platform. También puede obtenerlo mediante la operación QueryProductList.
ModelVersion	String	No	v1.0.0	El número de versión del modelo TSL que se va a consultar. Si no especifica este parámetro, IoT Platform devuelve el borrador del modelo TSL sin publicar.
Simple	Boolean	No	true	Indica si se recupera un modelo TSL simplificado. true: recupera un modelo TSL simplificado. Un modelo TSL simplificado incluye únicamente los atributos identifier y dataType de las propiedades, los servicios, los eventos y sus parámetros de entrada o salida. Los desarrolladores de dispositivos pueden usar estos modelos como referencia. false: recupera el modelo TSL completo. Un modelo TSL completo incluye todos los parámetros y valores de las propiedades, los servicios y los eventos. Los desarrolladores de aplicaciones en la nube pueden usar estos modelos como referencia. Valor predeterminado: false.
FunctionBlockId	String	No	BatteryModule	El identificador del módulo TSL personalizado. Cada identificador es único dentro de un producto. Si no especifica este parámetro, se consulta el módulo predeterminado.

Además de los parámetros de solicitud específicos de esta operación, debe especificar los parámetros de solicitud comunes al invocarla. Para obtener más información, consulte Parámetros de solicitud comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	El código de error que se devuelve si la llamada finaliza con errores. Para obtener más información, consulte Códigos de error.
Data	Struct		Los datos TSL que se devuelven si la llamada es exitosa.
TslStr	String	{\"schema\":\"https://iotx-tsl.oss-ap-southeast-1.aliyuncs.com/schema.json\",\"profile\":{\"productKey\":\"a14TeWI****\"},\"properties\":[{\"identifier\":\"Humidity\"}]}	La cadena del modelo TSL.
TslUri	String	https://iotx-pop-dsl.oss-cn-shanghai.aliyuncs.com/thing/a14T/model.json?Expires=1581947119&OSSAccessKeyId=LTAI&Signature=5i38	El URI que se utiliza para almacenar los datos TSL en Object Storage Service (OSS). Este URI es válido durante 60 minutos.
ErrorMessage	String	A system exception occurred.	El mensaje de error que se devuelve si la llamada finaliza con errores.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	El identificador de la solicitud.
Success	Boolean	true	Indica si la llamada fue exitosa. true: la llamada fue exitosa. false: la llamada finalizó con errores.

Ejemplos

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

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

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

Códigos de error

Para consultar la lista de códigos de error, visite el centro de errores de API.