调用接口更新指定产品物模型中的单个功能，支持同步更新物模型的扩展描述。

使用说明

  • 如果指定产品已发布，需先调用接口CancelReleaseProduct取消该产品发布，才能调用本接口更新物模型功能。
  • 如需更新功能定义信息，您可通过json-schema对ThingModelJson中的入参进行预校验，请参见ThingModelJson数据说明中的“校验”。
  • 单次调用最多可更新1个功能，即更新1个属性、服务或事件的定义信息。

QPS限制

单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为5。

说明 RAM用户共享阿里云账号配额。

调试

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

请求参数

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

系统规定参数。取值：UpdateThingModel。
ProductKey String 是 a1BwAGV****

产品的ProductKey。

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

IotInstanceId String 否 iot-cn-0pp1n8t****

实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。

注意
  • 若有ID值，必须传入该ID值，否则调用会失败。
  • 若无实例概览页面或ID值，则无需传入。

实例的更多信息，请参见实例概述。

Identifier String 否 Temperature

功能原有的标识符。

您可调用GetThingModelTsl，从返回参数TslStr中查看具体功能的identifier。

ThingModelJson String 否 { "properties":[ { "identifier": "SimCardType", "extendConfig":"{...}", "dataSpecs": { "max": "1", "dataType": "INT", "unit": "mmHg", "min": "0", "step": "1" }, "std": false, "custom": true, "dataType": "INT", "rwFlag": "READ_ONLY", "productKey": "a1Jw4i****", "required": false, "customFlag": true, "name": "sim卡类型＂ } ] }

新的功能定义详情。

  • Identifier不为空时，表示更新功能的标识符，最多能包含1个功能的标识符定义信息。
  • Identifier为空时，表示更新一个服务或事件下，输入或输出参数的定义，可包含多个参数的定义信息，最多不超过50个。

ThingModelJson的编写指导，请参见ThingModelJson数据说明。

FunctionBlockId String 否 BatteryModule

物模型自定义模块标识符，在产品中具有唯一性。

此参数和FunctionBlockName均不传入时，更新默认模块中功能。

FunctionBlockName String 否 电池模块

物模型的自定义模块名称。支持中文、英文字母、日文、数字和下划线（_），长度限制为4～30个字符，一个中文、一个日文算1个字符。

  • 此参数和FunctionBlockId均不传入时，更新默认模块中功能。
  • 如果传入此参数，必须与FunctionBlockId结合使用，可修改FunctionBlockId对应的自定义模块名称。
说明 不支持修改默认模块名称。

调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数文档。

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException

调用失败时，返回的错误码。更多信息，请参见错误码。

ErrorMessage String 系统异常

调用失败时，返回的出错信息。
RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

阿里云为该请求生成的唯一标识符。
Success Boolean true

表示是否调用成功。

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

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=UpdateThingModel
&ProductKey=a1Jw4id****
&ThingModelJson={"properties":[{"identifier": "SimCardType","dataSpecs": {"max": "1", "dataType": "INT","unit": "mmHg","min": "0","step": "1"},"std": false,"custom": true,"dataType": "INT","rwFlag": "READ_ONLY","productKey": "a1Jw4id****","required": false,"customFlag": true, "name": "sim卡类型"}]}
&Identifier=SimCardType
&<公共请求参数>

正常返回示例

XML格式 

<UpdateThingModelResponse>
  <RequestId>5573D217-8E3E-47AD-9331-2083B88E64B2</RequestId>
  <Success>true</Success>
</UpdateThingModelResponse>

JSON格式 

{
  "RequestId": "5573D217-8E3E-47AD-9331-2083B88E64B2",
  "Success": true
}

错误码

访问错误中心查看更多错误码。