176 lines
3.5 KiB
Markdown
176 lines
3.5 KiB
Markdown
# 节点模块
|
|
|
|
# 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 |
|
|
|
|
### 1.1 节点相关接口
|
|
|
|
#### 1.1.1 获取所有节点信息列表
|
|
|
|
POST 请求接口
|
|
|
|
> /api/node/list
|
|
|
|
请求参数
|
|
|
|
无
|
|
|
|
返回报文
|
|
|
|
```json
|
|
{
|
|
"code": 200,
|
|
"success": true,
|
|
"data": [
|
|
{
|
|
"id": "1",
|
|
"nodeName": "测试节点",
|
|
"nodeIp": "127.0.0.1",
|
|
"orgName": "某风电场",
|
|
"orgId": "1",
|
|
"revision": 1
|
|
}
|
|
],
|
|
"msg": "操作成功"
|
|
}
|
|
```
|
|
返参描述
|
|
|
|
| 参数名 | 参数类型 | 可选 | 描述 |
|
|
| ------------- | -------- | ---- |------|
|
|
| id | String | 否 | 节点ID |
|
|
| nodeName | String | 否 | 节点名称 |
|
|
| nodeIp | String | 否 | 节点IP |
|
|
| orgName | String | 否 | 机构名称 |
|
|
| orgId | String | 否 | 机构ID |
|
|
| revision | String | 否 | 乐观锁 |
|
|
|
|
|
|
#### 1.1.2 新增节点信息
|
|
|
|
POST 请求接口
|
|
|
|
> /api/node/add
|
|
|
|
请求参数
|
|
```json
|
|
{
|
|
"nodeName": "测试节点1",
|
|
"nodeIp": "127.0.0.1",
|
|
"orgId": "1"
|
|
}
|
|
```
|
|
|
|
入参描述
|
|
|
|
| 参数名 | 参数类型 | 可选 | 描述 |
|
|
| ------------- | -------- | ---- |------|
|
|
| nodeName | String | 否 | 节点名称 |
|
|
| nodeIp | String | 否 | 节点IP |
|
|
| orgId | String | 否 | 机构ID |
|
|
|
|
返回报文
|
|
|
|
```json
|
|
{
|
|
"code": 200,
|
|
"success": true,
|
|
"data": {
|
|
"id": "73535240297775104",
|
|
"nodeName": "测试节点1",
|
|
"nodeIp": "127.0.0.1",
|
|
"orgName": "某风电场",
|
|
"orgId": "1",
|
|
"revision": 1
|
|
},
|
|
"msg": "操作成功"
|
|
}
|
|
```
|
|
|
|
#### 1.1.3 修改节点信息
|
|
|
|
POST 请求接口
|
|
|
|
> /api/node/update
|
|
|
|
请求参数
|
|
```json
|
|
{
|
|
"id": "73535240297775104",
|
|
"nodeName": "测试节点1",
|
|
"nodeIp": "127.0.0.3",
|
|
"orgId": "1",
|
|
"revision": 2
|
|
}
|
|
```
|
|
返回报文
|
|
|
|
```json
|
|
{
|
|
"code": 200,
|
|
"success": true,
|
|
"data": {
|
|
"id": "73535240297775104",
|
|
"nodeName": "测试节点1",
|
|
"nodeIp": "127.0.0.3",
|
|
"orgName": "某风电场",
|
|
"orgId": "1",
|
|
"revision": 3
|
|
},
|
|
"msg": "操作成功"
|
|
}
|
|
```
|
|
|
|
#### 1.1.4 删除节点信息
|
|
|
|
POST 请求接口
|
|
|
|
> /api/node/delete
|
|
|
|
请求参数
|
|
```json
|
|
{
|
|
"id": "73535240297775104"
|
|
}
|
|
```
|
|
返回报文
|
|
|
|
```json
|
|
{
|
|
"code": 200,
|
|
"success": true,
|
|
"msg": "操作成功"
|
|
}
|
|
```
|
|
|
|
#### 1.1.5 配置下发
|
|
POST 请求接口
|
|
|
|
> /api/node/configUpdate
|
|
|
|
请求参数
|
|
```json
|
|
无
|
|
|
|
```
|
|
|
|
返回报文
|
|
|
|
```json
|
|
{
|
|
"code": 200,
|
|
"success": true,
|
|
"msg": "操作成功"
|
|
}
|
|
``` |