DeleteThingModel - IoT Platform

使用說明

如果指定產品發行，需先調用介面CancelReleaseProduct取消該產品發布，才能調用本介面刪除物模型中功能。
如果產品下有未發布的新增物模型功能定義或物模型自訂模組，也可調用該介面進行刪除。
調用該介面時，必須傳入請求參數ProductKey和指定的物模型（FunctionBlockId、PropertyIdentifier.N、ServiceIdentifier.N或EventIdentifier.N）。刪除指定產品下物模型功能定義邏輯如下：
- 僅傳入ProductKey和FunctionBlockId：刪除指定產品下指定的物模型自訂模組。
- 傳入ProductKey，及指定的PropertyIdentifier.N、ServiceIdentifier.N或EventIdentifier.N：刪除指定產品下物模型預設模組中指定的功能定義。此時，僅刪除已傳入且存在的指定功能定義。若傳入的PropertyIdentifier.N、ServiceIdentifier.N和EventIdentifier.N在預設模組中都不存在，調用本介面會報錯，提示功能定義不存在的錯誤碼資訊。
- 傳入ProductKey和FunctionBlockId，及指定的PropertyIdentifier.N、ServiceIdentifier.N或EventIdentifier.N：刪除指定產品下物模型自訂模組中指定的功能定義。此時，僅刪除已傳入且存在的指定功能定義。若傳入的PropertyIdentifier.N、ServiceIdentifier.N和EventIdentifier.N在自訂模組中都不存在，調用本介面會報錯，提示功能定義不存在的錯誤碼資訊。
  說明請求參數PropertyIdentifier.N、ServiceIdentifier.N和EventIdentifier.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.N、ServiceIdentifier.N或EventIdentifier.N不為空白時，傳入此參數，刪除自訂模組下指定功能；不傳入此參數，刪除預設模組下指定功能。 PropertyIdentifier.N、ServiceIdentifier.N和EventIdentifier.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
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。