调用该接口查看指定产品的物模型中的功能定义详情。

使用说明

物模型的功能定义详情中包含物模型中的所有属性、服务和事件定义。

限制说明

单阿里云账号调用该接口的每秒请求数(QPS)最大限制为10。

说明 子账号共享主账号配额。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String QueryThingModel

系统规定参数。取值:QueryThingModel。

ProductKey String a1BwAGV****

产品的ProductKey。

可以在物联网平台控制台产品页查看,或调用QueryProductList查看ProductKey的取值。

IotInstanceId String iot_instc_pu****_c*-v64********

公共实例不传此参数;您购买的实例需传入实例ID。

ResourceGroupId String rg-acfm4l5tcwd****

资源组ID。

说明 目前不传入此参数。
ModelVersion String v1.0.0

要查看的物模型版本号。

可调用ListThingModelVersion查看产品下的物模型版本号。

不传入此参数,则查询草稿状态的物模型功能定义;传入此参数,则查询指定版本的物模型功能定义。

调用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

表示是否调用成功。

  • true:调用成功。
  • false:调用失败。

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryThingModel
&ProductKey=a1bPo9p****
&ModelVersion=v1.0.0
&<公共请求参数>

正常返回示例

XML 格式

<QueryThingModelResponse>
  <Data>
        <ThingModelJson>{"productKey":"a14TeWI****","_ppk":{},"properties":[{"custom":true,"customFlag":true,"dataSpecs":{"dataType":"INT","max":"60","min":"55","step":"1","unit":"%"},"dataSpecsObject":{"unit":"%","min":"55","max":"60","dataType":"INT","step":"1"},"dataType":"INT","identifier":"Humidity","name":"湿度","productKey":"a14TeWIjbCO","propertyId":6647232,"required":false,"rwFlag":"READ_WRITE","std":false},{"custom":true,"customFlag":true,"dataSpecs":{"dataType":"FLOAT","max":"28","min":"26","step":"0.01","unit":"°C"},"dataSpecsObject":{"unit":"°C","min":"26","max":"28","dataType":"FLOAT","step":"0.01"},"dataType":"FLOAT","identifier":"Temperature","name":"温度","productKey":"a14TeWIjbCO","propertyId":6647233,"required":false,"rwFlag":"READ_WRITE","std":false}],"services":[],"events":[]}</ThingModelJson>
  </Data>
  <RequestId>3DB88928-389C-4C84-852D-1E141F6A5D07</RequestId>
  <Success>true</Success>
</QueryThingModelResponse>

JSON 格式

{
	"Data": {
		"ThingModelJson": "{\"productKey\":\"a14TeWI****\",\"_ppk\":{},\"properties\":[{\"custom\":true,\"customFlag\":true,\"dataSpecs\":{\"dataType\":\"INT\",\"max\":\"60\",\"min\":\"55\",\"step\":\"1\",\"unit\":\"%\"},\"dataSpecsObject\":{\"unit\":\"%\",\"min\":\"55\",\"max\":\"60\",\"dataType\":\"INT\",\"step\":\"1\"},\"dataType\":\"INT\",\"identifier\":\"Humidity\",\"name\":\"湿度\",\"productKey\":\"a14TeWIjbCO\",\"propertyId\":6647232,\"required\":false,\"rwFlag\":\"READ_WRITE\",\"std\":false},{\"custom\":true,\"customFlag\":true,\"dataSpecs\":{\"dataType\":\"FLOAT\",\"max\":\"28\",\"min\":\"26\",\"step\":\"0.01\",\"unit\":\"°C\"},\"dataSpecsObject\":{\"unit\":\"°C\",\"min\":\"26\",\"max\":\"28\",\"dataType\":\"FLOAT\",\"step\":\"0.01\"},\"dataType\":\"FLOAT\",\"identifier\":\"Temperature\",\"name\":\"温度\",\"productKey\":\"a14TeWIjbCO\",\"propertyId\":6647233,\"required\":false,\"rwFlag\":\"READ_WRITE\",\"std\":false}],\"services\":[],\"events\":[]}"
	},
	"RequestId": "3DB88928-389C-4C84-852D-1E141F6A5D07",
	"Success": true
}