map/docs/api/node.md

# 节点模块

# 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.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.2.9获取绑定设备树信息  | /api/node/link/getBindDeviceTree | 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": "操作成功"
}
```

## 1.2 链路相关接口

### 1.2.1 获取节点下的链路分页查询
POST 请求接口

> /api/node/link/list

请求参数
```json
{
  "nodeId":1
}

```
入参描述

| 参数名      | 参数类型 | 可选 | 描述   |
|----------| -------- | ---- |------| 
| nodeId   | String   | 否   | 节点Id |


返回报文

```json
{
  "total": 1,
  "rows": [
    {
      "id": "1",
      "linkName": "测试链路",
      "protocol": 1,
      "params": "测试",
      "nodeName": "测试节点",
      "nodeId": "1",
      "revision": 1
    }
  ],
  "code": 200,
  "msg": "查询成功"
}
```

返参描述

| 参数名      | 参数类型 | 可选 | 描述   |
|----------| -------- | ---- |------|
| id       | String   | 否   | 链路ID |
| linkName | String   | 否   | 链路名称 |
| protocol | String   | 否   | 协议类型 |
| params   | String   | 否   | 参数 |
| nodeName | String   | 否   | 节点名称 |
| nodeId   | String   | 否   | 节点ID |
| revision | String   | 否   | 乐观锁  |


### 1.2.2 新增链路
POST 请求接口

> /api/node/link/add

请求参数
```json
{
  "linkName": "测试链路1",
  "protocol": 1,
  "params": "测试",
  "nodeId": "1"
}

```
入参描述

| 参数名      | 参数类型 | 可选 | 描述   |
|----------| -------- | ---- |------| 
| linkName | String   | 否   | 链路名称 |
| protocol | String   | 否   | 协议类型 |
| params   | String   | 否   | 参数 |
| nodeId   | String   | 否   | 节点ID |

返回报文

```json
{
  "code": 200,
  "success": true,
  "data": {
    "id": "73556002258550784",
    "linkName": "测试链路1",
    "protocol": 1,
    "params": "测试",
    "nodeName": "测试节点",
    "nodeId": "1",
    "revision": 1
  },
  "msg": "操作成功"
}
```

### 1.2.3 修改链路
POST 请求接口

> /api/node/link/update

请求参数
```json
{
  "id": "73556002258550784",
  "linkName": "测试链路2",
  "protocol": 2,
  "params": "测试123",
  "nodeName": "测试节点",
  "nodeId": "1",
  "revision": 1
}

```

返回报文

```json
{
  "code": 200,
  "success": true,
  "data": {
    "id": "73556002258550784",
    "linkName": "测试链路1",
    "protocol": 1,
    "params": "测试",
    "nodeName": "测试节点",
    "nodeId": "1",
    "revision": 1
  },
  "msg": "操作成功"
}
```

### 1.2.4 删除链路
POST 请求接口

> /api/node/link/delete

请求参数
```json
{
  "id": "73556002258550784"
}

```

返回报文

```json
{
	"code": 200,
	"success": true,
	"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"
}

```

### 1.2.9 获取绑定设备树信息
POST 请求接口

> /api/node/link/getBindDeviceTree

请求参数
```json
{
  "linkId": "73556002258550784"
}

```


返回报文

```json
{
  "code": 200,
  "success": true,
  "data": [
    {
      "equipmentId": "73714632985149440",
      "equipmentName": "风电场测试",
      "porder": 1
    }
  ],
  "msg": "操作成功"
}
```