調用該接口為指定產(chǎn)品導入物模型。

使用說明

如果指定產(chǎn)品已發(fā)布，需先調用接口CancelReleaseProduct取消該產(chǎn)品發(fā)布，才能調用本接口導入物模型。

QPS限制

單個阿里云賬號調用該接口的每秒請求數(shù)（QPS）最大限制為5。

說明 單個阿里云賬號下的所有RAM用戶共享該阿里云賬號的配額。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數(shù)

名稱 類型 是否必選 示例值 描述
Action String 是 ImportThingModelTsl

系統(tǒng)規(guī)定參數(shù)。取值：ImportThingModelTsl。
ProductKey String 是 a1BwAGV****

產(chǎn)品的ProductKey。

可以在物聯(lián)網(wǎng)平臺控制臺產(chǎn)品頁查看，或調用QueryProductList查看ProductKey的取值。
IotInstanceId String 否 iot_instc_pu****_c*-v64********

實例ID。您可在物聯(lián)網(wǎng)平臺控制臺的實例概覽頁面，查看當前實例的ID。

重要
  • 若有ID值，必須傳入該ID值，否則調用會失敗。
  • 若無實例概覽頁面或ID值，則無需傳入。

實例的更多信息，請參見實例概述。
ResourceGroupId String 否 rg-acfm4l5tcwd****

資源組ID。

重要 目前，物聯(lián)網(wǎng)平臺僅支持實例維度的資源組管理。請求參數(shù)ResourceGroupId配置已無效，無需再傳入。
TslStr String 否 {"schema":"https://iotx-tsl.oss-ap-southeast-1.aliyuncs.com/schema.json","profile":{"productKey":"a14TeW****"},"properties":[]}

您編輯的物模型（TSL）。JSON格式的字符串。產(chǎn)品的物模型（TSL）包含屬性、服務和事件的定義。

TslStr格式需為標準的物模型數(shù)據(jù)格式，請參見物模型格式。

說明 目前該參數(shù)為必填參數(shù)，只能通過TslStr導入物模型。
TslUrl String 否 https://iotx-pop-dsl.oss-cn-shanghai.aliyuncs.com/thing/a14TeWI****/model.json?Expires=1581947119...

物模型數(shù)據(jù)在對象存儲（OSS）上的存儲地址URI。

說明 目前該參數(shù)暫時無效，請傳入TslStr導入物模型。
FunctionBlockId String 否 BatteryModule

物模型自定義模塊標識符，在產(chǎn)品中具有唯一性。支持英文大小寫字母、數(shù)字和下劃線（_），不超過30個字符。

需與FunctionBlockName結合使用。不傳入此參數(shù)時，導入默認模塊。
FunctionBlockName String 否 電池模塊

物模型的自定義模塊名稱。支持中文、英文字母、日文、數(shù)字和下劃線（_），長度限制為4～30個字符，一個中文、一個日文算1個字符。

需與FunctionBlockId結合使用。不傳入此參數(shù)時，導入默認模塊。

調用API時，除了本文介紹的該API的特有請求參數(shù)，還需傳入公共請求參數(shù)。公共請求參數(shù)說明，請參見公共參數(shù)文檔。

返回數(shù)據(jù)

名稱 類型 示例值 描述
Code String iot.system.SystemException

調用失敗時，返回的錯誤碼。更多信息，請參見錯誤碼。
ErrorMessage String 系統(tǒng)異常

調用失敗時，返回的出錯信息。
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\":[]}
&<公共請求參數(shù)>

正常返回示例

XML格式

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

JSON格式

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