CreateThingModel_物联网平台_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

使用说明

  • 如果指定产品已发布,需先调用接口 CancelReleaseProduct 取消该产品发布,才能调用本接口新增物模型功能。

  • 调用接口前,您可通过json-schemaThingModelJson 中的入参进行预校验,请参见 ThingModelJson 数据说明中的“校验”。

  • 单次调用最多可新增 10 个功能,即新增属性、服务和事件的数量总计不超过 10。

QPS 限制

单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为 5。

说明 RAM 用户共享阿里云账号配额。

流控信息

请求速率为5/1(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
iot:CreateThingModel
Create
全部资源
*

请求参数

字段名称字段详情
IotInstanceIdstring

实例 ID。您可在物联网平台控制台的实例概览页面,查看当前实例的 ID展开详情

示例值:iot-cn-0pp1n8t****
ProductKeystring

产品的 ProductKey,物联网平台为产品颁发的全局唯一标识符。展开详情

示例值:a1BwAGV****参考取值来源:
    CreateProduct
    QueryProductList
    ReleaseProduct
    ListProductByTags
    BindLicenseProduct
    BatchBindProductsIntoProject
ThingModelJsonstring

新增的功能定义详情。最多能包含 10 个功能的定义信息。展开详情

示例值:{ "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": "a1bPo9p****", "required": false, "customFlag": true, "name": "sim卡类型" } ], "services":[...], "events":[...] }参考取值来源:
    QueryThingModel
FunctionBlockIdstring

物模型自定义模块标识符,在产品中具有唯一性。支持英文大小写字母、数字和下划线(_),不超过 30 个字符。展开详情

示例值:BatteryModule
FunctionBlockNamestring

物模型的自定义模块名称。支持中文、英文字母、日文、数字和下划线(_),长度限制为 4~30 个字符,一个中文、一个日文算 1 个字符。展开详情

示例值:电池模块

请求说明

调用 API 时,除了本文介绍的该 API 的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档

返回参数

字段名称字段详情
Codestring

调用失败时,返回的错误码。更多信息,请参见错误码

示例值:iot.system.SystemException
ErrorMessagestring

调用失败时,返回的出错信息。

示例值:系统异常
RequestIdstring

阿里云为该请求生成的唯一标识符。

示例值:E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565
Successboolean

是否调用成功。展开详情

示例值:true

返回示例

变更历史

暂无变更历史

相关示例

物联网平台物模型的基本操作,创建、查询、删除等。
2022-01-30