ImportThingModelTsl - IoT Platform

使用說明

如果指定產品發行，需先調用介面CancelReleaseProduct取消該產品發布，才能調用本介面匯入物模型。

QPS限制

單個阿里雲帳號調用該介面的每秒請求數（QPS）最大限制為5。

說明單個阿里雲帳號下的所有RAM使用者共用該阿里雲帳號的配額。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	ImportThingModelTsl	系統規定參數。取值：ImportThingModelTsl。
ProductKey	String	是	a1BwAGV****	產品的ProductKey。可以在物聯網平台控制台產品頁查看，或調用QueryProductList查看ProductKey的取值。
IotInstanceId	String	否	iot_instc_pu***_c-v64********	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。
ResourceGroupId	String	否	rg-acfm4l5tcwd****	資源群組ID。重要目前，物聯網平台僅支援執行個體維度資源群組管理。請求參數ResourceGroupId配置已無效，無需再傳入。
TslStr	String	否	{"schema":"https://iotx-tsl.oss-ap-southeast-1.aliyuncs.com/schema.json","profile":{"productKey":"a14TeW****"},"properties":[]}	您編輯的物模型（TSL）。JSON格式的字串。產品的物模型（TSL）包含屬性、服務和事件的定義。 TslStr格式需為標準的物模型資料格式，請參見物模型格式。說明目前該參數為必填參數，只能通過TslStr匯入物模型。
TslUrl	String	否	https://iotx-pop-dsl.oss-cn-shanghai.aliyuncs.com/thing/a14TeWI****/model.json?Expires=1581947119...	物模型資料在Object Storage Service上的儲存地址URI。說明目前該參數暫時無效，請傳入TslStr匯入物模型。
FunctionBlockId	String	否	BatteryModule	物模型自訂模組標識符，在產品中具有唯一性。支援英文大小寫字母、數字和底線（_），不超過30個字元。需與FunctionBlockName結合使用。不傳入此參數時，匯入預設模組。
FunctionBlockName	String	否	電池模組	物模型的自訂模組名稱。支援中文、英文字母、日文、數字和底線（_），長度限制為4～30個字元，一個中文、一個日文算1個字元。需與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=ImportThingModelTsl
&ProductKey=a1lWSUw****
&TslStr={\"profile\":{\"productKey\": \"a1bPo9p****\"},\"services\":[],\"properties\":[],\"events\":[]}
&<公用請求參數>

正常返回樣本

XML格式

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

JSON格式

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

錯誤碼

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