API 列表
API 列表中包含里管理平台和用户平台各功能模块的所有 API。
管理平台
管理平台包括以下 API：
插件管理 API
| Name | Description |
|---|---|
| TMRegisterPlugin | 手动注册插件接口 |
| ListPlugin | 获取插件列表接口 |
| TMUpdatePluginIdentify | 获取插件绑定租户接口 |
| GetPlugin | 查询插件接口 |
| UninstallPlugin | 卸载插件接口 |
| InstallPlugin | 安装插件接口 |
| UpgradePlugin | 更新插件接口 |
| ListenableTenants | 获取插件绑定租户接口 |
| TenantDisable | 插件租户停用接口 |
| TenantEnable | 插件租户启用接口 |
租户管理 API
| Name | Description |
|---|---|
运维与管理 API
| Name | Description |
|---|---|
平台配置 API
| Name | Description |
|---|---|
租户平台
租户平台包括以下 API：
插件管理 API
| Name | Description |
|---|---|
设备管理 API
| Name | Description |
|---|---|
数据查询 API
| Name | Description |
|---|---|
| GetRawdata | 查询实体原始数据 |
| GetLatestEntities | 最近查询数据的实体 |
| GetTSData | 查询时序数据 |
数据订阅 API
| Name | Description |
|---|---|
| SubscribeByDevice | 添加设备订阅 |
| listSubscribe | 查询订阅列表 |
| unsubscribeEntitiesByIDs | 取消订阅 |
| subscribeEntitiesByGroups | 通过实体组添加到订阅 |
| subscribeEntitiesByModels | 通过模板添加到订阅 |
| createSubscribe | 创建订阅 |
| updateSubscribe | 更新订阅 |
| getSubscribe | 查询订阅 |
| deleteSubscribe | 删除订阅 |
| subscribeEntitiesByIDs | 通过实体id列表添加到订阅 |
| listSubscribeEntities | 查询订阅的实体列表 |
数据路由 API
| Name | Description |
|---|---|
| GetRuleDevices | 查询路由的设备列表 |
| RemoveDevicesFromRule | 从路由设备中删除设备 |
| AddDevicesToRule | 添加设备到路由 |
| ErrUnsubscribe | 取消错误信息订阅 |
| ErrSubscribe | 错误信息订阅 |
| ChangeErrSubscribe | 改变错误信息订阅 |
| ListRuleTarget | 查询路由目标列表 |
| CreateRuleTarget | 创建路由转发目标 |
| GetTableMap | 查询数据表结构映射 |
| UpdateTableMap | 更新数据表映射 |
| GetTableDetails | 查询数据表详情 |
| TesyConnectToKafka | 测试kafka配置 |
| ActionVerify | 验证转发配置 |
| QueryRule | 查询路由列表 |
| CreateRule | 创建路由 |
| DeleteRule | 删除路由 |
| UpdateRule | 更新路由 |
| GetRule | 查询路由详情 |
| GetRuleDevicesID | 查询路由的设备id列表 |
| SwitchRuleStatus | 切换路由状态 |
| DeleteRuleTarget | 删除路由目标 |
| UpdateRuleTarget | 更新路由转发目标 |
| TableList | 查询数据表列表 |
用户管理 API
| Name | Description |
|---|---|
监控告警 API
| Name | Description |
|---|---|