From 799ada8f19a649a0c2fe1789f2134e656f528421 Mon Sep 17 00:00:00 2001 From: chenhaojie Date: Mon, 29 Jul 2024 09:51:37 +0800 Subject: [PATCH] =?UTF-8?q?das=E6=8E=A5=E5=8F=A3=E6=96=87=E6=A1=A3?= =?UTF-8?q?=E4=BF=AE=E6=94=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/api/node.md | 111 ++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 100 insertions(+), 11 deletions(-) diff --git a/docs/api/node.md b/docs/api/node.md index 5b34c1d4..68286a6e 100644 --- a/docs/api/node.md +++ b/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 节点相关接口 @@ -330,4 +334,89 @@ POST 请求接口 "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" +} + ``` \ No newline at end of file