调用该接口查看指定产品物模型中的功能定义详情。
使用说明
物模型的功能定义详情中包含物模型中的所有属性、服务和事件定义。
如果产品物模型中添加了自定义模块，请求参数FunctionBlockId的值为空时，可获取到自定义模块列表；不为空时，可获取指定自定义模块的功能定义。
返回参数ThingModelJson取值的数据格式说明，请参见ThingModelJson数据说明。
QPS限制
单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为10。
说明 单个阿里云账号下的所有RAM用户共享该阿里云账号的配额。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
| Action | String | 是 | QueryThingModel | 系统规定参数。取值：QueryThingModel。 |
| IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** | 实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。 重要
实例的更多信息，请参见实例概述。 |
| ResourceGroupId | String | 否 | rg-acfm4l5tcwd**** | 资源组ID。 重要 目前，物联网平台仅支持实例维度的资源组管理。请求参数ResourceGroupId配置已无效，无需再传入。
|
| ProductKey | String | 否 | a1BwAGV**** | 产品的ProductKey。 |
| ModelVersion | String | 否 | v1.0.0 | 要查看的物模型版本号。 可调用ListThingModelVersion查看产品下的物模型版本号。 不传入此参数，则查询草稿状态的物模型功能定义；传入此参数，则查询指定版本的物模型功能定义。 |
| FunctionBlockId | String | 否 | BatteryModule | 物模型自定义模块标识符，在产品中具有唯一性。 不传入此参数时，查询默认模块数据。 |
调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数文档。
返回数据
| 名称 | 类型 | 示例值 | 描述 |
| Code | String | iot.system.SystemException | 调用失败时，返回的错误码。更多信息，请参见错误码。 |
| Data | Struct | 调用成功时，返回的数据。 |
|
| 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卡类型" } ], "services":[], "events":[] } | 物模型的功能定义。默认模块和自定义模块的物模型数据格式不同。 ThingModelJson取值的数据格式说明，请参见ThingModelJson数据说明。 |
| ErrorMessage | String | 系统异常 | 调用失败时，返回的出错信息。 |
| ProductKey | String | a1BwAGV**** | 产品的ProductKey。 |
| RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | 阿里云为该请求生成的唯一标识符。 |
| Success | Boolean | true | 表示是否调用成功。
|
示例
请求示例
https://iot.cn-shanghai.aliyuncs.com/?Action=QueryThingModel
&ProductKey=a1bPo9p****
&ModelVersion=v1.0.0
&<公共请求参数>正常返回示例
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":"唤醒数据","productKey":"a114xeJGj2p","required":false,"rwFlag":"READ_ONLY","std":false}],"services":[]}</ThingModelJson>
</Data>
<Success>true</Success>
</QueryThingModelResponse>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\":\"唤醒数据\",\"productKey\":\"a114xeJGj2p\",\"required\":false,\"rwFlag\":\"READ_ONLY\",\"std\":false}],\"services\":[]}"
},
"Code": "",
"Success": true
}错误码
访问错误中心查看更多错误码。