Skip to content

Commit f769dda

Browse files
authored
Merge pull request #579 from fengzeroz/master
get group subscribe api
2 parents 86283e7 + 030ebc9 commit f769dda

File tree

2 files changed

+74
-0
lines changed

2 files changed

+74
-0
lines changed

en_US/api/configuration.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1519,6 +1519,43 @@ To update both group name and interval:
15191519
}
15201520
```
15211521

1522+
## Get subscribe status of groups
1523+
1524+
*GET* /api/v2/subscribes
1525+
1526+
### Request Params
1527+
1528+
**app** required
1529+
1530+
**name** optional, substring match driver name or group name
1531+
1532+
### Request Headers
1533+
1534+
**Authorization** Bearer \<token\>
1535+
1536+
### Response Status
1537+
1538+
* 200
1539+
* 400
1540+
1541+
### Response
1542+
1543+
```json
1544+
{
1545+
"drivers": [
1546+
{
1547+
"name": "modbus",
1548+
"groups": [
1549+
{
1550+
"name": "g3",
1551+
"subscribed": true
1552+
}
1553+
]
1554+
}
1555+
]
1556+
}
1557+
```
1558+
15221559
## Get Version
15231560

15241561
*GET* /api/v2/version

zh_CN/api/configuration.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1530,6 +1530,43 @@ Neuron 将为 IIoT 平台提供一系列 API 服务,用于查询基本信息
15301530
}
15311531
```
15321532

1533+
## 获取组订阅状态
1534+
1535+
*GET* /api/v2/subscribes
1536+
1537+
### 请求参数
1538+
1539+
**app** 必需
1540+
1541+
**name** 可选,对南向节点名称或组名称进行过滤
1542+
1543+
### 请求头部
1544+
1545+
**Authorization** Bearer \<token\>
1546+
1547+
### 响应状态
1548+
1549+
* 200
1550+
* 400
1551+
1552+
### 响应
1553+
1554+
```json
1555+
{
1556+
"drivers": [
1557+
{
1558+
"name": "modbus",
1559+
"groups": [
1560+
{
1561+
"name": "g3",
1562+
"subscribed": true
1563+
}
1564+
]
1565+
}
1566+
]
1567+
}
1568+
```
1569+
15331570
## 获取版本信息
15341571

15351572
*GET* /api/v2/version

0 commit comments

Comments
 (0)