全部产品
Search

搜索本产品

    阿里云物联网平台：ImportThingModelTsl

    文档中心

    阿里云物联网平台：ImportThingModelTsl

    更新时间：Sep 15, 2023

    调用该接口为指定产品导入物模型。

    使用说明

    如果指定产品已发布，需先调用接口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...

    物模型数据在对象存储（OSS）上的存储地址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
}

    错误码

    访问错误中心查看更多错误码。