调用该接口删除指定产品下物模型中的功能(属性、服务、事件)。

使用说明

  • 如果指定产品已发布,需先调用接口CancelReleaseProduct取消该产品发布,才能调用本接口删除物模型中功能。
  • 如果产品下有未发布的新增物模型功能定义或物模型自定义模块,也可调用该接口进行删除。
  • 调用该接口时 ,必须传入请求参数ProductKey。删除指定产品下物模型功能定义逻辑如下:
    • 仅传入ProductKey:删除指定产品下所有的物模型自定义模块,及物模型默认模块下所有的功能定义。
    • 仅传入ProductKeyFunctionBlockId:删除指定产品下指定的物模型自定义模块。
    • 传入ProductKey,及指定的PropertyIdentifier.NServiceIdentifier.NEventIdentifier.N:删除指定产品下物模型默认模块中指定的功能定义。此时,仅删除已传入且存在的指定功能定义。若传入的PropertyIdentifier.NServiceIdentifier.NEventIdentifier.N在默认模块中都不存在,则相当于仅传入ProductKey的删除操作。
    • 传入ProductKeyFunctionBlockId,及指定的PropertyIdentifier.NServiceIdentifier.NEventIdentifier.N:删除指定产品下物模型自定义模块中指定的功能定义。此时,仅删除已传入且存在的指定功能定义。若传入的PropertyIdentifier.NServiceIdentifier.NEventIdentifier.N在自定义模块中都不存在,则相当于仅传入ProductKeyFunctionBlockId的删除操作。
      说明 请求参数PropertyIdentifier.NServiceIdentifier.NEventIdentifier.N,最多各传入10个标识符。
  • 调用该接口删除物模型功能后,必须调用PublishThingModel接口重新发布对应产品的物模型,删除物模型功能的操作才能生效。

QPS限制

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

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

调试

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

请求参数

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

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

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

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

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

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

FunctionBlockId String BatteryModule

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

  • PropertyIdentifier.NServiceIdentifier.NEventIdentifier.N不为空时,传入此参数,删除自定义模块下指定功能;不传入此参数,删除默认模块下指定功能。
  • PropertyIdentifier.NServiceIdentifier.NEventIdentifier.N都为空时,传入此参数,删除该模块及其下所有功能定义。
ProductKey String a1BwAGV****

产品的ProductKey。

PropertyIdentifier.N RepeatList Temperature

需要删除的属性标识符列表。最多传入10个属性标识符。

ServiceIdentifier.N RepeatList Set

需要删除的服务标识符列表。最多传入10个服务标识符。

EventIdentifier.N RepeatList OfflineAlert

需要删除的事件标识符列表。最多传入10个事件标识符。

ResourceGroupId String rg-acfm4l5tcwd****

资源组ID。

说明 目前不传入此参数。

调用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=DeleteThingModel
&ProductKeySource=a1rYuVF****
&PropertyIdentifier.1=speed
&ServiceIdentifier.1=SetSpeed
&EventIdentifier.1=SpeedAlarm
&<公共请求参数>

正常返回示例

XML格式

<DeleteThingModelResponse>
  <RequestId>9E76053E-26ED-4AB4-AE58-8AFC3F1E7E8E</RequestId>
  <Success>true</Success>
</DeleteThingModelResponse>

JSON格式

{
  "RequestId": "9E76053E-26ED-4AB4-AE58-8AFC3F1E7E8E",
  "Success": true
}