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

说明

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

请求参数

名称 类型 是否必需 描述
Action String 要执行的操作,取值:QueryThingModel
ProductKey String 产品的ProductKey。

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

ModelVersion String 要查看的物模型版本号。

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

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

IotInstanceId String 公共实例不传此参数;您购买的实例需传入实例ID。
公共请求参数 - 请参见公共参数

返回参数

名称 类型 描述
RequestId String 阿里云为该请求生成的唯一标识符。
Success Boolean 是否调用成功。true表示调用成功,false表示调用失败。
ErrorMessage String 调用失败时,返回的出错信息。
Code String 调用失败时,返回的错误码。错误码详情,请参见错误码
Data Struct 调用成功时,返回的数据。详情请参见下表Data。
表 1. Data
名称 类型 描述
ThingModelJson String 物模型的功能定义。ThingModelJson取值的数据格式说明,请参见ThingModelJson数据说明

示例:

{
  "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":[]

}

示例

请求示例

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

返回示例

  • JSON格式
    {
      "Data": {
        "ThingModelJson": "{\"productKey\":\"a1bPo9p****\",\"_ppk\":{},\"properties\":[{\"identifier\":\"SimCardType\",\"dataSpecs\":{\"max\":\"1\",\"dataType\":\"INT\",\"unit\":\"mmHg\",\"min\":\"0\",\"step\":\"1\"},\"std\":false,\"custom\":true,\"dataType\":\"INT\",\"rwFlag\":\"READ_ONLY\",\"configCode\":\"03F7B23CD285458AB191E0881F889BE91579420094360\",\"productKey\":\"a1Jw4idFWHX\",\"required\":false,\"customFlag\":true,\"dataSpecsObject\":{\"unit\":\"mmHg\",\"min\":\"0\",\"max\":\"1\",\"dataType\":\"INT\",\"step\":\"1\"},\"name\":\"sim卡类型\",\"extendConfig\":\"{\\\"originalDataType\\\":{\\\"specs\\\":{\\\"registerCount\\\":1,\\\"reverseRegister\\\":0,\\\"swap16\\\":0},\\\"type\\\":\\\"bool\\\"},\\\"identifier\\\":\\\"SimCardType\\\",\\\"registerAddress\\\":\\\"0x03\\\",\\\"scaling\\\":1,\\\"writeFunctionCode\\\":0,\\\"operateType\\\":\\\"inputStatus\\\",\\\"pollingTime\\\":1000,\\\"trigger\\\":1}\"}],\"services\":[],\"events\":[]}"
      },
      "RequestId": "CAC786EA-048E-4FDC-8B64-961DD4BE4A4E",
      "Success": true
    }
  • XML格式
    <?xml version="1.0" encoding="UTF-8"?>
     <QueryThingModelResponse>
          <Data>
            <ThingModelJson>{\"productKey\":\"a1bPo9p****\",\"_ppk\":{},\"properties\":[{\"identifier\":\"SimCardType\",\"dataSpecs\":{\"max\":\"1\",\"dataType\":\"INT\",\"unit\":\"mmHg\",\"min\":\"0\",\"step\":\"1\"},\"std\":false,\"custom\":true,\"dataType\":\"INT\",\"rwFlag\":\"READ_ONLY\",\"configCode\":\"03F7B23CD285458AB191E0881F889BE91579420094360\",\"productKey\":\"a1Jw4idFWHX\",\"required\":false,\"customFlag\":true,\"dataSpecsObject\":{\"unit\":\"mmHg\",\"min\":\"0\",\"max\":\"1\",\"dataType\":\"INT\",\"step\":\"1\"},\"name\":\"sim卡类型\",\"extendConfig\":\"{\\\"originalDataType\\\":{\\\"specs\\\":{\\\"registerCount\\\":1,\\\"reverseRegister\\\":0,\\\"swap16\\\":0},\\\"type\\\":\\\"bool\\\"},\\\"identifier\\\":\\\"SimCardType\\\",\\\"registerAddress\\\":\\\"0x03\\\",\\\"scaling\\\":1,\\\"writeFunctionCode\\\":0,\\\"operateType\\\":\\\"inputStatus\\\",\\\"pollingTime\\\":1000,\\\"trigger\\\":1}\"}],\"services\":[],\"events\":[]}</ThingModelJson>
          </Data>
          <RequestId>C4FDA54C-4201-487F-92E9-022F42387458</RequestId>
          <Success>true</Success>
     </QueryThingModelResponse>