Consulta las funciones del modelo de Thing Specification Language (TSL) de un producto específico.
Notas de uso
Las funciones de TSL incluyen propiedades, servicios y eventos.
Si se agregaron módulos personalizados al modelo TSL de un producto, deje vacío el parámetro FunctionBlockId para obtener las funciones TSL de todos los módulos personalizados, o especifíquelo para obtener las funciones TSL de un módulo personalizado específico.
Para obtener más información sobre el formato de datos del parámetro de respuesta ThingModelJson, consulte Estructura de datos de ThingModelJson.
Límites de QPS
Puede llamar a esta operación hasta 10 veces por segundo por cuenta.
Los usuarios RAM de una cuenta de Alibaba Cloud comparten la cuota de la cuenta.
Depuración
Parámetros de solicitud
|
Parámetro |
Tipo |
Obligatorio |
Ejemplo |
Descripción |
|
Action |
String |
Sí |
QueryThingModel |
La operación que desea realizar. Establezca el valor en QueryThingModel. |
|
IotInstanceId |
String |
No |
iot_instc_pu**_c-v64* |
El ID de la instancia. Puede consultar el ID de la instancia en la pestaña Overview de la consola de IoT Platform. Importante
Para obtener más información sobre las instancias, consulte Descripción general. |
|
ResourceGroupId |
String |
No |
rg-acfm4l5tcwd**** |
El ID del resource group. Importante
IoT Platform admite la gestión de resource groups únicamente por instancia. El parámetro ResourceGroupId no es válido. No es necesario que especifique este parámetro. |
|
ProductKey |
String |
No |
a1BwAGV**** |
La clave ProductKey del producto. |
|
ModelVersion |
String |
No |
v1.0.0 |
El número de versión del modelo TSL. Puede llamar a la operación ListThingModelVersion para consultar los números de versión del modelo TSL de un producto. Si no especifica este parámetro, se consulta el borrador del modelo TSL. Si lo especifica, se consulta el modelo TSL de la versión indicada. |
|
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 la operación, también debe especificar los parámetros de solicitud comunes. Para obtener más información, 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 obtener más información, consulte Códigos de error. |
|
Data |
Struct |
Los datos devueltos si la solicitud fue exitosa. |
|
|
ThingModelJson |
String |
{ "productKey":"a1Jw4id***", "_ppk":{ "version":"1.1", "description":"xxx" }, "properties":[ { "identifier": "SimCardType", "dataSpecs": { "max": "1", "dataType": "INT", "unit": "mmHg", "min": "0", "step": "1" }, "std": false, "custom": true, "dataType": "INT", "rwFlag": "READ_ONLY", "productKey": "a1Jw4idFWHX", "required": false, "customFlag": true, "name": "SIM card type" } ], "services":[], "events":[] } |
Las funciones del modelo TSL. El formato de datos difiere entre el módulo predeterminado y los módulos personalizados. Para obtener más información sobre el formato de datos del parámetro ThingModelJson, consulte Estructura de datos de ThingModelJson. |
|
ErrorMessage |
String |
A system exception occurred. |
El mensaje de error devuelto si la solicitud falló. |
|
ProductKey |
String |
a1BwAGV**** |
La clave ProductKey del producto. |
|
RequestId |
String |
E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 |
El ID de la solicitud. |
|
Success |
Boolean |
true |
Indica si la solicitud fue exitosa.
|
Ejemplos
Solicitudes de ejemplo
https://iot.cn-shanghai.aliyuncs.com/?Action=QueryThingModel
&ProductKey=a1bPo9p****
&ModelVersion=v1.0.0
&<Common request parameters>Respuestas exitosas de ejemplo
Formato XML
<QueryThingModelResponse>
<RequestId>1F9041A2-ED5B-4A5A-9C44-598E28C0B434</RequestId>
<Data>
<ThingModelJson>{"_ppk":{"version":"1594253010934"},"events":[],"productKey":"a114xeJ****","properties":[{"configCode":"8C03F0EEC63D4897BF2637F89AE36B011594227294067","custom":true,"customFlag":true,"dataSpecs":{"custom":true,"dataType":"INT","max":"1","min":"0","step":"1","unit":"ppb"},"dataType":"INT","description":"1","extendConfig":"{\"originalDataType\":{\"specs\":{\"registerCount\":1,\"reverseRegister\":0,\"swap16\":0},\"type\":\"bool\"},\"identifier\":\"WakeUpData\",\"registerAddress\":\"0x04\",\"scaling\":1,\"writeFunctionCode\":0,\"operateType\":\"inputStatus\",\"pollingTime\":1000,\"trigger\":1}","identifier":"WakeUpData","name":"Wakeup_Data","productKey":"a114xeJGj2p","required":false,"rwFlag":"READ_ONLY","std":false}],"services":[]}</ThingModelJson>
</Data>
<Success>true</Success>
</QueryThingModelResponse>Formato JSON
{
"RequestId": "1F9041A2-ED5B-4A5A-9C44-598E28C0B434",
"Data": {
"ThingModelJson": "{\"_ppk\":{\"version\":\"1594253010934\"},\"events\":[],\"productKey\":\"a114xeJ****\",\"properties\":[{\"configCode\":\"8C03F0EEC63D4897BF2637F89AE36B011594227294067\",\"custom\":true,\"customFlag\":true,\"dataSpecs\":{\"custom\":true,\"dataType\":\"INT\",\"max\":\"1\",\"min\":\"0\",\"step\":\"1\",\"unit\":\"ppb\"},\"dataType\":\"INT\",\"description\":\"1\",\"extendConfig\":\"{\\\"originalDataType\\\":{\\\"specs\\\":{\\\"registerCount\\\":1,\\\"reverseRegister\\\":0,\\\"swap16\\\":0},\\\"type\\\":\\\"bool\\\"},\\\"identifier\\\":\\\"WakeUpData\\\",\\\"registerAddress\\\":\\\"0x04\\\",\\\"scaling\\\":1,\\\"writeFunctionCode\\\":0,\\\"operateType\\\":\\\"inputStatus\\\",\\\"pollingTime\\\":1000,\\\"trigger\\\":1}\",\"identifier\":\"WakeUpData\",\"name\":\"Wakeup_Data\",\"productKey\":\"a114xeJGj2p\",\"required\":false,\"rwFlag\":\"READ_ONLY\",\"std\":false}],\"services\":[]}"
},
"Code": "",
"Success": true
}Códigos de error
Para obtener una lista de códigos de error, consulte Códigos de error del servicio.