CreateDataSourceItem_物联网平台_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.

接口说明

使用说明

调用该接口前,请先创建数据源,具体操作,请参见创建数据源的步骤 1~步骤 6;然后在物联网平台控制台对应实例下消息转发 > 云产品流转页面的数据源页签,查看数据源 ID

注意 对于开源 MQTT 托管形态产品和设备,及 MQTT 云网关产品和设备,Topic 为自定义的消息 Topic 时,必须传入 ScopeTypeProductKey。若 ScopeTypeDEVICE,还需传入 DeviceName

QPS 限制

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

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

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

具体说明如下:展开详情

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

请求参数

字段名称字段详情
IotInstanceIdstring

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

示例值:iot-0pp1n8t***
DataSourceIdinteger<int64>

数据源 ID。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1002参考取值来源:
    ListParserDataSource
    AttachParserDataSource
    CreateParserDataSource
取值 <= 999999999999
Topicstring

应用到规则引擎的具体 Topic,格式一般为:/${productKey}/${deviceName}/topicShortName。其中,${productKey}是设备所属产品的 ProductKey${deviceName}是具体设备的名称,topicShortName是 Topic 剩余部分。展开详情

示例值:/as/mqtt/status/gy***z/+参考取值来源:
    SubscribeTopic
    UnsubscribeTopic
    QueryProductTopic
    CreateProductTopic
ProductKeystring

自定义的消息 Topic 所属产品的 ProductKey展开详情

示例值:gy***z参考取值来源:
    CreateProduct
    QueryProductList
    ReleaseProduct
    ListProductByTags
    BindLicenseProduct
    BatchBindProductsIntoProject
DeviceNamestring

自定义的消息 Topic 所属的设备名称。展开详情

示例值:device1
ScopeTypestring

自定义的消息 Topic 订阅的作用域,可取值:展开详情

示例值:PRODUCT枚举值:PRODUCTDEVICE

请求说明

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

返回参数

字段名称字段详情
Codestring

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

示例值:iot.system.SystemException
ErrorMessagestring

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

示例值:系统异常
RequestIdstring

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

示例值:E4C0FF92-2A86-41DB-92D3-73B60310D25E
Successboolean

表示是否调用成功。展开详情

示例值:true

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
iot.prod.NotExistedProduct
The specified product does not exist.诊断
400
iot.system.SystemException
An internal error occurred. Try again later.诊断
400
iot.common.InvalidFormattedParameter
The parameter format is invalid.诊断
400
iot.common.QueryProductActionError
query product info fail诊断
400
iot.rule.DataSourceNotExists
data source not exist诊断
400
iot.rule.ItemExceedsLimit
item exceeds limit诊断
400
iot.rule.DataSourceItemExists
data source item exist诊断
400
iot.common.TooManyRequest
Request frequency is too high诊断

变更历史

暂无变更历史

相关示例

物联网平台/规则引擎/云产品流转(新版)/数据源https://iot.console.aliyun.com/rule/list
2022-07-20