插件下载了解更多
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安装插件之前，确保已安装 JetBrains IDE安装插件之前，确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
接口说明
QPS 限制
单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为 10。
说明
RAM 用户共享阿里云账号配额。
流控信息
当前云产品API请求速率暂未透出。
请求参数
| 字段名称 | 字段详情 |
|---|---|
Configurationstring | 数据目的对应的配置信息，传入格式为 JSON String。不同规则动作类型所需内容不同，具体要求和示例请参见本表格下方的参数补充说明。 示例值:{"topic":"/a1POX0c****/device1/user/get","topicType":1} |
IotInstanceIdstring | 实例 ID。您可在物联网平台控制台的实例概览页面，查看当前实例的 ID。展开详情 示例值:iot-2w**** |
Typestring | 数据目的操作类型，可取值：展开详情 示例值:REPUBLISH |
Namestring | 数据目的名称。 示例值:DataPurpose |
Descriptionstring | 数据目的描述信息。 示例值:数据流转至数据库。 |
请求说明
REPUBLISH 类型 Configuration 定义
| 名称 | 描述 |
|---|---|
| productKey | 转发至另一个 Topic 所属产品的 ProductKey。 |
REPUBLISH 类型 Configuration 示例：
{
"productKey":"hf****3xn"
}
AMQP 类型 Configuration 定义
| 名称 | 描述 |
|---|---|
| groupId | 消费组 ID。 |
AMQP 类型 Configuration 示例：
{
"groupId":"ZTh1JmuZcUfv44p4z00****"
}
OTS 类型 Configuration 定义
| 名称 | 描述 |
|---|---|
| instanceName | 表格存储中用来接收信息的实例名称。 |
| regionName | 目标实例所在的阿里云地域代码，例如 cn-shanghai。 |
| tableName | 表格存储中用来接收信息的数据表名称。 |
| role | 授权角色信息。通过授予物联网平台指定的系统服务角色，您可以授权物联网平台访问您的表格存储。授权角色信息：{"roleName":"AliyunIOTAccessingOTSRole","roleArn":"acs:ram::${uid}:role/aliyuniotaccessingotsrole"}${uid}为您的阿里云账号 ID。您可以登录控制台，在账号安全设置页面查看您的账号 ID。AliyunIOTAccessingOTSRole是访问控制中定义的服务角色。用于授予物联网平台访问表格存储。关于角色的更多信息，请在访问控制 RAM 控制台的角色管理页面进行角色管理。 |
OTS 类型 Configuration 示例：
{
"instanceName":"${instanceName}",
"regionName":"cn-shanghai",
"tableName":"test_table",
"role":{
"roleName":"AliyunIOTAccessingOTSRole",
"roleArn":"acs:ram::${uid}:role/aliyuniotaccessingotsrole"
}
}
DATAHUB 类型 Configuration 定义
| 名称 | 描述 |
|---|---|
| projectName | 目标 DataHub 中用来接收信息的具体 Project。 |
| topicName | 目标 DataHub 中用来接收信息的具体 Topic。 |
| regionName | 目标 DataHub 所在的阿里云地域代码，例如 cn-shanghai。 |
| role | 授权角色信息。通过授予 IoT 指定的系统服务角色，您可以授权物联网平台访问您的 DataHub。授权角色信息格式：{"roleArn":"acs:ram::${uid}:role/aliyuniotaccessingdatahubrole","roleName": "AliyunIOTAccessingDataHubRole"}${uid}为您的阿里云账号 ID。您可以登录控制台，在账号安全设置页面查看您的账号 ID。AliyunIOTAccessingDataHubRole是访问控制中定义的服务角色。用于授予物联网平台访问 DataHub。关于角色的更多信息，请在访问控制 RAM 控制台的角色管理页面进行角色管理。 |
DATAHUB 类型 Configuration 示例：
{
"role":{
"roleArn": "acs:ram::${uid}:role/aliyuniotaccessingdatahubrole",
"roleName": "AliyunIOTAccessingDataHubRole"
},
"ProjectName": "test_project_name",
"RegionName": "cn-shanghai",
"TopicName": "test_topic"
}
MNS 类型 Configuration 定义
| 名称 | 描述 |
|---|---|
| themeName | 消息服务中用来接收信息的目标主题名称。 |
| regionName | 目标消息服务所在的阿里云地域代码，例如 cn-shanghai。 |
| role | 授权角色信息。通过授予物联网平台指定的系统服务角色，您可以授权物联网平台访问您的消息服务。授权角色信息：{"roleArn":"acs:ram::${uid}:role/aliyuniotaccessingmnsrole","roleName": "AliyunIOTAccessingMNSRole"}${uid}为您的阿里云账号 ID。您可以登录控制台，在账号安全设置页面查看您的账号 ID。AliyunIOTAccessingMNSRole是访问控制中定义的服务角色。用于授予物联网平台访问消息服务。关于角色的更多信息，请在访问控制 RAM 控制台的角色管理页面进行角色管理。 |
MNS 类型Configuration示例：
{
"themeName": "test_name",
"role":{
"roleArn": "acs:ram::${uid}:role/aliyuniotaccessingmnsrole",
"roleName": "AliyunIOTAccessingMNSRole"
},
"regionName": "cn-shanghai"
}
ONS 类型 Configuration 定义
说明
您需通过调用消息队列 RocketMQ 的 SDK，或在消息队列 RocketMQ 控制台，授权物联网平台访问消息队列 RocketMQ（至少要授予物联网平台发布权限），然后才能够成功创建将 Topic 数据转发至消息队列 RocketMQ 的规则动作。
| 名称 | 描述 |
|---|---|
| instanceId | RocketMQ 中用来接收消息的目标 Topic 所属的实例 ID。 |
| topic | RocketMQ 中用来接收信息的目标 Topic。 |
| regionName | 目标 RocketMQ 实例所在的阿里云地域代码，例如 cn-shanghai。 目前仅支持同地域内数据流转。 |
| role | 授权角色信息。通过授予物联网平台指定的系统服务角色，您可以授权物联网平台访问您的消息队列 RocketMQ 服务。授权角色信息：{"roleArn":"acs:ram::${uid}:role/aliyuniotaccessingmqrole","roleName": "AliyunIOTAccessingMQRole"}${uid}为您的阿里云账号 ID。您可以登录控制台，在账号安全设置页面查看您的账号 ID。AliyunIOTAccessingMQRole是访问控制中定义的服务角色。用于授予物联网平台访问消息队列 RocketMQ。关于角色的更多信息，请在访问控制 RAM 控制台的角色管理页面进行角色管理。 |
ONS 类型 Configuration 示例：
{
"instanceId": "${MQ_INST_ID}",
"role":
{
"roleArn": "acs:ram::${uid}:role/aliyuniotaccessingmqrole",
"roleName": "AliyunIOTAccessingMQRole"
},
"regionName": "cn-shanghai",
"topic": "test_topic"
}
FC 类型 Configuration 定义
| 名称 | 描述 |
|---|---|
| functionName | 函数服务中用来接收信息的目标函数名称。 |
| serviceName | 函数服务中用来接收信息的目标服务名称。 |
| regionName | 目标函数服务实例所在阿里云地域的代码，如 cn-shanghai。 |
| role | 授权角色信息。通过授予物联网平台指定的系统服务角色，您可以授权物联网平台访问您的函数计算服务。授权角色信息：{"roleArn":"acs:ram::${uid}:role/aliyuniotaccessingfcrole","roleName": "AliyunIOTAccessingFCRole"}${uid}为您的阿里云账号 ID。您可以登录控制台，在账号安全设置页面查看您的账号 ID。AliyunIOTAccessingFCRole是访问控制中定义的服务角色。用于授予物联网平台访问函数计算。关于角色的更多信息，请在访问控制 RAM 控制台的角色管理页面进行角色管理。 |
FC 类型 Configuration 示例：
{
"role":
{
"roleArn": "acs:ram::${uid}:role/aliyuniotaccessingfcrole",
"roleName": "AliyunIOTAccessingFCRole"
},
"functionName": "${function_name}",
"serviceName": "${service_name}",
"regionName": "cn-shanghai"
}
调用 API 时，除了本文介绍的该 API 的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数文档。
返回参数
返回示例
错误码
没有我想要的错误码, 点击 反馈
全局错误码变更历史
暂无变更历史