調用該接口刪除指定產品下物模型中的功能(屬性、服務、事件)。

使用說明

  • 如果指定產品已發布,需先調用接口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用戶共享該阿里云賬號的配額。

調試

您可以在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。

重要 目前,物聯網平臺僅支持實例維度的資源組管理。請求參數ResourceGroupId配置已無效,無需再傳入。

調用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
}