From 030ebc9725cd42ce769d09ec7bed9ff8aa10b113 Mon Sep 17 00:00:00 2001 From: fengzero Date: Wed, 20 Aug 2025 06:24:15 +0000 Subject: [PATCH] get group subscribe api --- en_US/api/configuration.md | 37 +++++++++++++++++++++++++++++++++++++ zh_CN/api/configuration.md | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 74 insertions(+) diff --git a/en_US/api/configuration.md b/en_US/api/configuration.md index a82747d1..46831274 100644 --- a/en_US/api/configuration.md +++ b/en_US/api/configuration.md @@ -1519,6 +1519,43 @@ To update both group name and interval: } ``` +## Get subscribe status of groups + +*GET* /api/v2/subscribes + +### Request Params + +**app** required + +**name** optional, substring match driver name or group name + +### Request Headers + +**Authorization** Bearer \ + +### Response Status + +* 200 +* 400 + +### Response + +```json +{ + "drivers": [ + { + "name": "modbus", + "groups": [ + { + "name": "g3", + "subscribed": true + } + ] + } + ] +} +``` + ## Get Version *GET* /api/v2/version diff --git a/zh_CN/api/configuration.md b/zh_CN/api/configuration.md index fff7fa4a..fe1b54df 100644 --- a/zh_CN/api/configuration.md +++ b/zh_CN/api/configuration.md @@ -1530,6 +1530,43 @@ Neuron 将为 IIoT 平台提供一系列 API 服务,用于查询基本信息 } ``` +## 获取组订阅状态 + +*GET* /api/v2/subscribes + +### 请求参数 + +**app** 必需 + +**name** 可选,对南向节点名称或组名称进行过滤 + +### 请求头部 + +**Authorization** Bearer \ + +### 响应状态 + +* 200 +* 400 + +### 响应 + +```json +{ + "drivers": [ + { + "name": "modbus", + "groups": [ + { + "name": "g3", + "subscribed": true + } + ] + } + ] +} +``` + ## 获取版本信息 *GET* /api/v2/version