DeleteThingModel_物联网平台_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

使用说明

  • 如果指定产品已发布,需先调用接口 CancelReleaseProduct 取消该产品发布,才能调用本接口删除物模型中功能。

  • 如果产品下有未发布的新增物模型功能定义或物模型自定义模块,也可调用该接口进行删除。

  • 调用该接口时,必须传入请求参数 ProductKey 和指定的物模型(FunctionBlockIdPropertyIdentifier.NServiceIdentifier.NEventIdentifier.N)。删除指定产品下物模型功能定义逻辑如下:

    • 仅传入 ProductKeyFunctionBlockId:删除指定产品下指定的物模型自定义模块。
    • 传入 ProductKey,及指定的PropertyIdentifier.NServiceIdentifier.NEventIdentifier.N:删除指定产品下物模型默认模块中指定的功能定义。此时,仅删除已传入且存在的指定功能定义。若传入的PropertyIdentifier.NServiceIdentifier.NEventIdentifier.N在默认模块中都不存在,调用本接口会报错,提示功能定义不存在的错误码信息。
    • 传入 ProductKeyFunctionBlockId,及指定的PropertyIdentifier.NServiceIdentifier.NEventIdentifier.N:删除指定产品下物模型自定义模块中指定的功能定义。此时,仅删除已传入且存在的指定功能定义。若传入的PropertyIdentifier.NServiceIdentifier.NEventIdentifier.N在自定义模块中都不存在,调用本接口会报错,提示功能定义不存在的错误码信息。
    说明 请求参数PropertyIdentifier.NServiceIdentifier.NEventIdentifier.N,最多各传入 10 个标识符。
  • 调用该接口删除物模型功能后,必须调用 PublishThingModel 接口重新发布对应产品的物模型,删除物模型功能的操作才能生效。

QPS 限制

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

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

流控信息

请求速率为5/1(s)。更多流控信息,请前往配额中心查看

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称字段详情
IotInstanceIdstring

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

示例值:iot-cn-0pp1n8t****
ResourceGroupIdstring

资源组 ID。

示例值:rg-acfm4l5tcwd****
ProductKeystring

产品的 ProductKey。

示例值:a1BwAGV****参考取值来源:
    CreateProduct
    QueryProductList
    ReleaseProduct
    ListProductByTags
    BindLicenseProduct
    BatchBindProductsIntoProject
FunctionBlockIdstring

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

示例值:BatteryModule
PropertyIdentifierarray<string>

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

示例值:Temperature子级条数 <= 100
ServiceIdentifierarray<string>

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

示例值:Set子级条数 <= 100
EventIdentifierarray<string>

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

示例值:OfflineAlert子级条数 <= 100

请求说明

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

返回参数

字段名称字段详情
Codestring

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

示例值:iot.system.SystemException
ErrorMessagestring

调用失败时,返回的出错信息。

示例值:系统异常
RequestIdstring

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

示例值:E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565
Successboolean

表示是否调用成功。展开详情

示例值:true

返回示例

变更历史

暂无变更历史

相关示例

物联网平台物模型的基本操作,创建、查询、删除等。
2022-01-30