583 lines
11 KiB
Markdown
583 lines
11 KiB
Markdown
# 计算模块
|
|
|
|
# API接口一览表
|
|
|
|
| 接口分类 | 接口描述 | API接口 | 权限 |
|
|
|-------|-----------------|----------------------------------| ---------------------------- |
|
|
| 1.计算模块 | 1.1.1获取所有计算模块列表 | /api/calc/module/list | SYS_AUTHORITY_ID_ADMIN |
|
|
| | 1.1.2注册或者更新计算模块 | /api/calc/module/register | SYS_AUTHORITY_ID_ADMIN |
|
|
| | 1.1.3卸载计算模块 | /api/calc/module/remove | SYS_AUTHORITY_ID_ADMIN |
|
|
| | 1.1.4激活计算模块 | /api/node/module/active | |
|
|
| | 1.1.5禁用计算模块 | /api/calc/module/deactive | |
|
|
| | 1.1.5获取计算模块脚本 | /api/calc/module/script | |
|
|
|
|
|
|
## 1.1 计算模块相关接口
|
|
|
|
### 1.1.1 获取所有计算模块列表
|
|
|
|
POST 请求接口
|
|
|
|
> /api/calc/module/list
|
|
|
|
请求参数
|
|
|
|
无
|
|
|
|
返回报文
|
|
|
|
```json
|
|
{
|
|
"code": 200,
|
|
"success": true,
|
|
"data": [
|
|
{
|
|
"name": "WindFarmStatistics",
|
|
"localName": "风场计实时统计量",
|
|
"version": "1.0.1",
|
|
"description": "计算风场的实时统计量，包括：全场总有功功率、全场总无功功率、全场平均风速、并网机组台数、故障机组台数、待机机组台、断连机组台数。",
|
|
"disabled": 0,
|
|
"cron": "0 */5 * * ?"
|
|
}
|
|
],
|
|
"msg": "操作成功"
|
|
}
|
|
```
|
|
返参描述
|
|
|
|
| 参数名 | 参数类型 | 可选 | 描述 |
|
|
| ------------- | -------- | ---- |------|
|
|
| name | String | 否 | 计算模块名称 |
|
|
| localName | String | 否 | 计算模块中文名 |
|
|
| version | String | 否 | 版本号 |
|
|
| description | String | 否 | 计算模块备注 |
|
|
| disabled | String | 否 | 是否禁用 |
|
|
| cron | String | 否 | 计算任务定时表达式 |
|
|
|
|
|
|
### 1.1.2 注册或者关联计算模块
|
|
|
|
POST 请求接口, form-data方式
|
|
|
|
> /api/calc/module/register
|
|
|
|
|
|
入参描述
|
|
|
|
| 参数名 | 参数类型 | 可选 | 描述 |
|
|
| ------------- | -------- | ---- |------|
|
|
| file | String | 否 | 计算模块脚本文件 |
|
|
|
|
|
|
返回报文
|
|
|
|
```json
|
|
{
|
|
"code": 200,
|
|
"success": true,
|
|
"msg": "操作成功"
|
|
}
|
|
```
|
|
|
|
### 1.1.3 修改节点信息
|
|
|
|
POST 请求接口
|
|
|
|
> /api/calc/module/remove
|
|
|
|
请求参数
|
|
```json
|
|
{
|
|
"moduleName": "WindFarmStatistics"
|
|
}
|
|
```
|
|
返回报文
|
|
|
|
```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",
|
|
"type": 138
|
|
}
|
|
|
|
```
|
|
|
|
返回报文
|
|
|
|
```json
|
|
{
|
|
"code": 200,
|
|
"success": true,
|
|
"data": [
|
|
{
|
|
"id": "75974000971874304",
|
|
"linkId": "74303135031754752",
|
|
"linkName": "倍福1.5链路",
|
|
"equipmentId": "1846101273013739522",
|
|
"equipmentName": "A-001",
|
|
"equipmentCode": "A-001",
|
|
"measPointType": 146,
|
|
"measPointCode": "setGenSpeedLimitValue",
|
|
"measPointName": "发电机转速给定值",
|
|
"porder": 14,
|
|
"params": "{\"name\":\"发电机转速给定值\",\"code\":\"setGenSpeedLimitValue\",\"col1\":0,\"col2\":6,\"col3\":0,\"col4\":\"\",\"col5\":183,\"col6\":\"\"}"
|
|
},
|
|
{
|
|
"id": "75974000971874305",
|
|
"linkId": "74303135031754752",
|
|
"linkName": "倍福1.5链路",
|
|
"equipmentId": "1846101273013739522",
|
|
"equipmentName": "A-001",
|
|
"equipmentCode": "A-001",
|
|
"measPointType": 146,
|
|
"measPointCode": "setGenSpeedLimitValue",
|
|
"measPointName": "发电机转速给定值",
|
|
"porder": 14,
|
|
"params": "{\"name\":\"发电机转速给定值\",\"code\":\"setGenSpeedLimitValue\",\"col1\":0,\"col2\":6,\"col3\":0,\"col4\":\"\",\"col5\":183,\"col6\":\"\"}"
|
|
},
|
|
{
|
|
"id": "75974000971874306",
|
|
"linkId": "74303135031754752",
|
|
"linkName": "倍福1.5链路",
|
|
"equipmentId": "1846101273013739522",
|
|
"equipmentName": "A-001",
|
|
"equipmentCode": "A-001",
|
|
"measPointType": 146,
|
|
"measPointCode": "setActivePowerLimitValue",
|
|
"measPointName": "有功功率给定值",
|
|
"porder": 15,
|
|
"params": "{\"name\":\"有功功率给定值\",\"code\":\"setActivePowerLimitValue\",\"col1\":0,\"col2\":6,\"col3\":0,\"col4\":\"\",\"col5\":184,\"col6\":\"\"}"
|
|
},
|
|
{
|
|
"id": "75974000971874307",
|
|
"linkId": "74303135031754752",
|
|
"linkName": "倍福1.5链路",
|
|
"equipmentId": "1846101273013739522",
|
|
"equipmentName": "A-001",
|
|
"equipmentCode": "A-001",
|
|
"measPointType": 146,
|
|
"measPointCode": "setActivePowerLimitValue",
|
|
"measPointName": "有功功率给定值",
|
|
"porder": 15,
|
|
"params": "{\"name\":\"有功功率给定值\",\"code\":\"setActivePowerLimitValue\",\"col1\":0,\"col2\":6,\"col3\":0,\"col4\":\"\",\"col5\":184,\"col6\":\"\"}"
|
|
},
|
|
{
|
|
"id": "75974000971874308",
|
|
"linkId": "74303135031754752",
|
|
"linkName": "倍福1.5链路",
|
|
"equipmentId": "1846101273013739522",
|
|
"equipmentName": "A-001",
|
|
"equipmentCode": "A-001",
|
|
"measPointType": 146,
|
|
"measPointCode": "setReactivePowerValue",
|
|
"measPointName": "无功功率给定值",
|
|
"porder": 16,
|
|
"params": "{\"name\":\"无功功率给定值\",\"code\":\"setReactivePowerValue\",\"col1\":0,\"col2\":6,\"col3\":0,\"col4\":\"\",\"col5\":185,\"col6\":\"\"}"
|
|
},
|
|
{
|
|
"id": "75974000971874309",
|
|
"linkId": "74303135031754752",
|
|
"linkName": "倍福1.5链路",
|
|
"equipmentId": "1846101273013739522",
|
|
"equipmentName": "A-001",
|
|
"equipmentCode": "A-001",
|
|
"measPointType": 146,
|
|
"measPointCode": "setReactivePowerValue",
|
|
"measPointName": "无功功率给定值",
|
|
"porder": 16,
|
|
"params": "{\"name\":\"无功功率给定值\",\"code\":\"setReactivePowerValue\",\"col1\":0,\"col2\":6,\"col3\":0,\"col4\":\"\",\"col5\":185,\"col6\":\"\"}"
|
|
}
|
|
],
|
|
"msg": "操作成功"
|
|
}
|
|
```
|
|
|
|
### 1.2.6 绑定设备信息
|
|
POST 请求接口
|
|
|
|
> /api/node/link/bindDeviceMeas
|
|
|
|
请求参数
|
|
```json
|
|
{
|
|
"linkId": "75979266885156864",
|
|
"equipmentList": [
|
|
{
|
|
"id": "1846101273013739522",
|
|
"name": "A-001",
|
|
"iotModelId": "1807685851882508289",
|
|
"iotAddr": "127.168.0.1"
|
|
},
|
|
{
|
|
"id": "75817384363950080",
|
|
"name": "A-002",
|
|
"iotModelId": "1807685851882508289",
|
|
"iotAddr": "127.168.0.2"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
返回报文
|
|
|
|
```json
|
|
{
|
|
"code": 200,
|
|
"success": true,
|
|
"msg": "操作成功"
|
|
}
|
|
```
|
|
|
|
### 1.2.7 导入映射表信息
|
|
POST 请求接口
|
|
|
|
> /api/node/link/importMappingList
|
|
|
|
请求参数
|
|
```json
|
|
{
|
|
"id": "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": [
|
|
{
|
|
"id": "1846101273013739522",
|
|
"name": "A-001",
|
|
"iotModelId": "1807685851882508289",
|
|
"iotAddr": "127.168.0.1"
|
|
},
|
|
{
|
|
"id": "75817384363950080",
|
|
"name": "A-002",
|
|
"iotModelId": "1807685851882508289",
|
|
"iotAddr": "127.168.0.2"
|
|
}
|
|
],
|
|
"msg": "操作成功"
|
|
}
|
|
```
|
|
|
|
### 1.2.10 保存测点信息
|
|
POST 请求接口
|
|
|
|
> /api/node/link/saveMappingList
|
|
|
|
请求参数
|
|
```json
|
|
{
|
|
"linkId": "73556002258550784",
|
|
"equipmentId": "73714632985149440",
|
|
"type": 139,
|
|
"params": "{}"
|
|
}
|
|
|
|
```
|
|
|
|
|
|
返回报文
|
|
|
|
```json
|
|
{
|
|
"code": 200,
|
|
"success": true,
|
|
"msg": "操作成功"
|
|
}
|
|
```
|
|
|
|
### 1.2.11单设备遥控操作
|
|
|
|
POST 请求接口
|
|
|
|
> /api/node/link/command
|
|
|
|
请求参数
|
|
|
|
```sjon
|
|
{
|
|
"deviceId": "1846101273013739522",
|
|
"serviceName": "setTurbineFastStart",
|
|
"opValue": 1
|
|
}
|
|
```
|
|
|
|
|
|
|
|
### 1.2.12单设备遥调操作
|
|
|
|
POST 请求接口
|
|
|
|
> /api/node/link/setPoint
|
|
|
|
请求参数
|
|
|
|
```json
|
|
{
|
|
"deviceId": "1846101273013739522",
|
|
"serviceName": "setActivePowerLimitValue",
|
|
"opValue": 52.5
|
|
}
|
|
```
|
|
|
|
|
|
|