UpdateThingModel - IoT Platform

使用說明

如果指定產品發行，需先調用介面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
}

錯誤碼

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