das接口文档修改
This commit is contained in:
parent
04ebb63568
commit
799ada8f19
111
docs/api/node.md
111
docs/api/node.md
@ -2,17 +2,21 @@
|
||||
|
||||
# API接口一览表
|
||||
|
||||
| 接口分类 | 接口描述 | API接口 | 权限 |
|
||||
|-------|--------------------------|------------------------| ---------------------------- |
|
||||
| 1.1节点 | 1.1.1获取所有节点信息列表 | /api/node/list | |
|
||||
| | 1.1.2新增节点信息 | /api/node/add | |
|
||||
| | 1.1.3修改节点信息 | /api/node/update | SYS_AUTHORITY_ID_ADMIN |
|
||||
| | 1.1.4删除节点信息 | /api/node/delete | SYS_AUTHORITY_ID_ADMIN |
|
||||
| | 1.1.5配置下发 | /api/node/configUpdate | SYS_AUTHORITY_ID_ADMIN |
|
||||
| 1.2链路 | 1.2.1获取所有链路分页查询 | /api/node/link/list | |
|
||||
| | 1.2.2新增链路信息 | /api/node/link/add | SYS_AUTHORITY_ID_ADMIN |
|
||||
| | 1.2.3修改链路信息 | /api/node/link/update | SYS_AUTHORITY_ID_ADMIN |
|
||||
| | 1.2.4删除链路信息 | /api/node/link/delete | SYS_AUTHORITY_ID_ADMIN |
|
||||
| 接口分类 | 接口描述 | API接口 | 权限 |
|
||||
|-------|-----------------|----------------------------------| ---------------------------- |
|
||||
| 1.1节点 | 1.1.1获取所有节点信息列表 | /api/node/list | |
|
||||
| | 1.1.2新增节点信息 | /api/node/add | |
|
||||
| | 1.1.3修改节点信息 | /api/node/update | SYS_AUTHORITY_ID_ADMIN |
|
||||
| | 1.1.4删除节点信息 | /api/node/delete | SYS_AUTHORITY_ID_ADMIN |
|
||||
| | 1.1.5配置下发 | /api/node/configUpdate | SYS_AUTHORITY_ID_ADMIN |
|
||||
| 1.2链路 | 1.2.1获取所有链路分页查询 | /api/node/link/list | |
|
||||
| | 1.2.2新增链路信息 | /api/node/link/add | SYS_AUTHORITY_ID_ADMIN |
|
||||
| | 1.2.3修改链路信息 | /api/node/link/update | SYS_AUTHORITY_ID_ADMIN |
|
||||
| | 1.2.4删除链路信息 | /api/node/link/delete | SYS_AUTHORITY_ID_ADMIN |
|
||||
| | 1.2.5获取映射表信息 | /api/node/link/getMappingList | SYS_AUTHORITY_ID_ADMIN |
|
||||
| | 1.2.6绑定设备信息 | /api/node/link/bindDeviceMeas | SYS_AUTHORITY_ID_ADMIN |
|
||||
| | 1.2.7导入映射表信息 | /api/node/link/importMappingList | SYS_AUTHORITY_ID_ADMIN |
|
||||
| | 1.2.8导出映射表信息 | /api/node/link/exportMappingList | SYS_AUTHORITY_ID_ADMIN |
|
||||
|
||||
### 1.1 节点相关接口
|
||||
|
||||
@ -331,3 +335,88 @@ POST 请求接口
|
||||
"msg": "操作成功"
|
||||
}
|
||||
```
|
||||
|
||||
#### 1.2.5 获取映射表信息
|
||||
POST 请求接口
|
||||
|
||||
> /api/node/link/getMappingList
|
||||
|
||||
请求参数
|
||||
```json
|
||||
{
|
||||
"linkId": "73556002258550784"
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
返回报文
|
||||
|
||||
```json
|
||||
{
|
||||
"code": 200,
|
||||
"success": true,
|
||||
"data": {
|
||||
"id": "73560002258550784",
|
||||
"linkId": "73556002258550784",
|
||||
"equipmentId": "73556002258550784",
|
||||
"equipmentAttribute": "hight",
|
||||
"equipmentService": "ceshifangfa",
|
||||
"porder": 1,
|
||||
"params":"{bindAddr:127.0.0.1,bindPort:80,targetPort:443,targetAddr:114.114.114.114,socketType:1}",
|
||||
"revision": 1
|
||||
},
|
||||
"msg": "操作成功"
|
||||
}
|
||||
```
|
||||
|
||||
#### 1.2.6 绑定设备信息
|
||||
POST 请求接口
|
||||
|
||||
> /api/node/link/bindDeviceMeas
|
||||
|
||||
请求参数
|
||||
```json
|
||||
{
|
||||
"equipmentId": ["1788084346705514497"],
|
||||
"linkId": "73556002258550784"
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
返回报文
|
||||
|
||||
```json
|
||||
{
|
||||
"code": 200,
|
||||
"success": true,
|
||||
"msg": "操作成功"
|
||||
}
|
||||
```
|
||||
|
||||
#### 1.2.7 导入映射表信息
|
||||
POST 请求接口
|
||||
|
||||
> /api/node/link/importMappingList
|
||||
|
||||
请求参数
|
||||
```json
|
||||
{
|
||||
"linkId": "73556002258550784"
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
#### 1.2.8 导出映射表信息
|
||||
POST 请求接口
|
||||
|
||||
> /api/node/link/exportMappingList
|
||||
|
||||
请求参数
|
||||
```json
|
||||
{
|
||||
"linkId": "73556002258550784"
|
||||
}
|
||||
|
||||
```
|
Loading…
Reference in New Issue
Block a user