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

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

Límites de QPS

Puede invocar esta operación hasta 20 veces por segundo por cuenta.

Nota

Los usuarios de Resource Access Management (RAM) de una cuenta de Alibaba Cloud comparten la cuota de dicha cuenta.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos invocar esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	GetThingModelTslPublished	La operación que desea ejecutar. Establezca el valor en GetThingModelTslPublished.
ProductKey	String	Sí	a1BwAGV****	El ProductKey del producto.
IotInstanceId	String	No	iot-cn-0pp1n8t****	El ID de la instancia. Consulte el ID de instancia en la página Descripción general de la consola de IoT Platform. Importante Si su instancia tiene un ID, debe especificar este parámetro. De lo contrario, la solicitud fallará. Si la página Descripción general o el ID de instancia no se muestran en la consola de IoT Platform, no es necesario especificar este parámetro. Para más información, consulte Descripción general.
ResourceGroupId	String	No	rg-acfm4l5tcwd****	El ID del resource group. Importante IoT Platform permite gestionar únicamente instancias por resource group. ResourceGroupId no surte efecto. No es necesario especificar este parámetro.
Simple	Boolean	No	true	Especifica si se devuelve un modelo TSL simplificado. Valores válidos: true: devuelve un modelo TSL simplificado. Este modelo define únicamente las propiedades, servicios y eventos del dispositivo, así como el identificador y el tipo de datos de los parámetros de entrada y salida. Los desarrolladores de dispositivos pueden usar los modelos TSL simplificados como referencia. false (predeterminado): devuelve un modelo TSL completo. Este modelo define las propiedades, servicios y eventos del dispositivo, además de todos los parámetros y valores. Los desarrolladores de aplicaciones en la nube pueden usar los modelos TSL completos como referencia.
ModelVersion	String	No	v1.0.0	El número de versión del modelo TSL. Puede invocar la operación ListThingModelVersion para consultar el número de versión del modelo TSL de un producto. Si no especifica este parámetro, se utiliza la última versión publicada del modelo TSL.
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 utiliza el módulo predeterminado.

Además de los parámetros específicos de la operación mencionados anteriormente, debe especificar los parámetros de solicitud comunes al invocar esta operación. Para más información sobre los parámetros de solicitud comunes, consulte Parámetros comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	El código de error devuelto si la solicitud falló. Para más información, consulte Códigos de error.
Data	Struct		Los datos devueltos.
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 identificador uniforme de recursos (URI) de los datos TSL almacenados en Object Storage Service (OSS). El URI tiene una validez de 60 minutos.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la solicitud falló.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	El ID de la solicitud.
Success	Boolean	true	Indica si la solicitud se completó correctamente. Valores válidos: true false

Ejemplos

Solicitudes de ejemplo

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

Respuestas correctas de ejemplo

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

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\":\"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
}

Códigos de error

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.