修改计算模块接口文档
This commit is contained in:
谷成伟
parent
74eed15299
commit
7492250b02
423
docs/api/calc.md
423
docs/api/calc.md
@ -123,7 +123,7 @@ POST 请求接口
|
||||
}
|
||||
```
|
||||
|
||||
### 1.1.5 配置下发
|
||||
### 1.1.5 禁用计算模块
|
||||
POST 请求接口
|
||||
|
||||
> /api/node/module/deactive
|
||||
@ -143,431 +143,30 @@ POST 请求接口
|
||||
"msg": "禁用成功"
|
||||
}
|
||||
|
||||
## 1.2 链路相关接口
|
||||
|
||||
### 1.2.1 获取节点下的链路分页查询
|
||||
### 1.1.6 获取指定计算模块脚本内容
|
||||
POST 请求接口
|
||||
|
||||
> /api/node/link/list
|
||||
> /api/node/module/script
|
||||
|
||||
请求参数
|
||||
```json
|
||||
{
|
||||
"nodeId":1
|
||||
"moduleName": "WindFarmStatistics"
|
||||
}
|
||||
|
||||
```
|
||||
入参描述
|
||||
|
||||
| 参数名 | 参数类型 | 可选 | 描述 |
|
||||
|----------| -------- | ---- |------|
|
||||
| nodeId | String | 否 | 节点Id |
|
||||
|
||||
|
||||
返回报文
|
||||
|
||||
```json
|
||||
{
|
||||
"total": 1,
|
||||
"rows": [
|
||||
{
|
||||
"id": "1",
|
||||
"linkName": "测试链路",
|
||||
"protocol": 1,
|
||||
"params": "测试",
|
||||
"nodeName": "测试节点",
|
||||
"nodeId": "1",
|
||||
"revision": 1
|
||||
}
|
||||
],
|
||||
"code": 200,
|
||||
"msg": "查询成功"
|
||||
"code": 200,
|
||||
"success": true,
|
||||
"data": "IyMgTmFtZTogV2luZEZhcm1TdGF0aXN0aWNzDQojIyBMb2NhbE5hbWU6IOmjjuWcuuiuoeWunuaXtue7n+iuoemHjw0KIyMgVmVyc2lvbjoxLjAuMQ0KIyMgQ3JvbjowICovNSAqICogPw0KIyMgRGVzY3JpcHRpb246IOiuoeeul+mjjuWcuueahOWunuaXtue7n+iuoemHj++8jOWMheaLrO+8muWFqOWcuuaAu+acieWKn+WKn+eOh+OAgeWFqOWcuuaAu+aXoOWKn+WKn+eOh+OAgeWFqOWcuuW5s+Wdh+mjjumAn+OAgeW5tue9keacuue7hOWPsOaVsOOAgeaVhemanOacuue7hOWPsOaVsOOAgeW+heacuuacuue7hOWPsOOAgeaWrei/nuacuue7hOWPsOaVsOOAgg0KDQojIyDmraTohJrmnKzorqHnrpfpo47lnLrnmoTkuIDkupvnu5/orqHmlbDmja46DQojIyDohJrmnKznmoTliY3kupTooYzms6jph4rkuLrohJrmnKzlpLTljLrln5/vvIzloavlhpnohJrmnKzln7rnoYDkv6Hmga8uDQoNCiMjIOiOt+WPlumjjuWcuuS/oeaBr+WIl+ihqA0KbGV0IEdFTlMgPWZpbHRlciggR19ERVZJQ0VTLCBsYW1iZGEoZGV2KS0+IGRldi5vYmplY3RUeXBlID09IDEwMDAyIGVuZCk7DQoNCiMjIOWumuS5iemcgOimgeiOt+WPlueahOWunuaXtuaVsOaNrg0KbGV0IGF0dHJzID0gc2VxLmxpc3QoImlHZW5Qb3dlcjFzIiwiaVJlYWN0aXZlUG93ZXIiLCJpV2luZFNwZWVkMXMiLCJpVHVyYmluZU9wZXJhdGlvbk1vZGUiKTsNCg0KIyMg57uT5p6c5Y+Y6YePIC0g5YWo5Zy65oC75pyJ5Yqf5Yqf546HDQpsZXQgV2luZEZhcm1BY3RpdmVQb3dlciA9IDAuMDsNCiMjIOe7k+aenOWPmOmHjyAtIOWFqOWcuuaAu+aXoOWKn+WKn+eOhw0KbGV0IFdpbmRGYXJtUmVhY3RpdmVQb3dlciA9IDAuMDsNCiMjIOe7k+aenOWPmOmHjyAtIOWFqOWcuuW5s+Wdh+mjjumAnw0KbGV0IFdpbmRGYXJtQXZnV2luZFNwZWVkID0gbmlsOw0KIyMg57uT5p6c5Y+Y6YePIC0g5bm2572R5py657uE5Y+w5pWwDQpsZXQgVHVyYmluZUNvdW50UG93ZXJQcm9kID0gMDsNCiMjIOe7k+aenOWPmOmHjyAtIOaVhemanOacuue7hOWPsOaVsA0KVHVyYmluZUNvdW50RmF1bHRlZCA9IDA7DQojIyDnu5Pmnpzlj5jph48gLSDlvoXmnLrmnLrnu4Tlj7DmlbANClR1cmJpbmVDb3VudElkbGUgPSAwOw0KIyMg57uT5p6c5Y+Y6YePIC0g5pat6L+e5py657uE5Y+w5pWwDQpUdXJiaW5lQ291bnREaXNjb25uZWN0ZWQgPSAwOw0KDQojIyDkuLTml7blj5jph48NCg0KbGV0IHRfd2luZEZhcm1Ub3RhbCA9IDAuMDsNCmxldCB0X3dpbmRGYXJtQXZhaWxhYmxlQ291bnQgPSAwOw0KDQpmb3IgZyBpbiBHRU5TIHsNCiAgICAjIyDojrflj5bpo47mnLrlrp7ml7bmlbDmja4NCglsZXQgdiA9IHJ0KGcuZGV2aWNlQ29kZSwgYXR0cnMpOw0KDQogICAgIyMg57Sv5Yqg6K6h566XIOWFqOWcuuaAu+acieWKn+WKn+eOhw0KCWlmICh2LmlHZW5Qb3dlcjFzICE9IG5pbCkgew0KCQlXaW5kRmFybUFjdGl2ZVBvd2VyID0gV2luZEZhcm1BY3RpdmVQb3dlciArIHYuaUdlblBvd2VyMXM7DQoJfQ0KDQogICAgIyMg57Sv5Yqg6K6h566XIOWcuuaAu+aXoOWKn+WKn+eOhw0KCWlmICh2LmlSZWFjdGl2ZVBvd2VyICE9IG5pbCkgew0KCQlXaW5kRmFybVJlYWN0aXZlUG93ZXIgPSBXaW5kRmFybVJlYWN0aXZlUG93ZXIgKyB2LmlSZWFjdGl2ZVBvd2VyOw0KCX0NCg0KICAgICMjIOe0r+WKoOacieaViOeahOW5s+Wdh+mjjumAn+WPiumjjuWcuuS4quaVsA0KCWlmICh2LmlXaW5kU3BlZWQxcyAhPSBuaWwpIHsNCiAgICAgICAgdF93aW5kRmFybVRvdGFsID0gdF93aW5kRmFybVRvdGFsICsgdi5pV2luZFNwZWVkMXM7DQogICAgICAgIHRfd2luZEZhcm1BdmFpbGFibGVDb3VudCA9IHRfd2luZEZhcm1BdmFpbGFibGVDb3VudCArIDE7DQoJfQ0KDQoJIyMg6K6h566X5bm2572R5Y+w5pWw77yM5b6F5py65py657uE5Y+w5pWw77yM5pat6L+e5py657uE5Y+w5pWwDQoJaWYgKCB2LmlUdXJiaW5lT3BlcmF0aW9uTW9kZSA9PSAyMCB8fCB2LmlUdXJiaW5lT3BlcmF0aW9uTW9kZSA9PSAyMSApIHsNCgkJVHVyYmluZUNvdW50UG93ZXJQcm9kID0gVHVyYmluZUNvdW50UG93ZXJQcm9kICsgMTsNCgl9DQoJZWxzaWYgKCB2LmlUdXJiaW5lT3BlcmF0aW9uTW9kZSA9PSAxMSApIHsNCgkJVHVyYmluZUNvdW50SWRsZSA9IFR1cmJpbmVDb3VudElkbGUgKyAxOw0KCX0NCgllbHNpZiAoIHYuaVR1cmJpbmVPcGVyYXRpb25Nb2RlID09IDAgKSB7DQoJCVR1cmJpbmVDb3VudERpc2Nvbm5lY3RlZCA9IFR1cmJpbmVDb3VudERpc2Nvbm5lY3RlZCArIDE7DQoJfQ0KfQ0KDQojIyDorqHnrpcg5YWo5Zy65bmz5Z2H6aOO6YCfDQppZiAoIHRfd2luZEZhcm1BdmFpbGFibGVDb3VudCAhPSAwICl7DQogICAgV2luZEZhcm1BdmdXaW5kU3BlZWQgPSB0X3dpbmRGYXJtVG90YWwgLyB0X3dpbmRGYXJtQXZhaWxhYmxlQ291bnQ7DQp9DQojIyDkv53lrZjpo47lnLrnmoTorqHnrpfph48NCmxldCBjdXJyVGltZSA9IHN5c2RhdGUoKTsNCnNhdmUoIkEwIiwgY3VyclRpbWUsICJXaW5kRmFybUFjdGl2ZVBvd2VyIiwgV2luZEZhcm1BY3RpdmVQb3dlciwNCgkJCWN1cnJUaW1lLCAiV2luZEZhcm1SZWFjdGl2ZVBvd2VyIiwgV2luZEZhcm1SZWFjdGl2ZVBvd2VyLA0KCQkJY3VyclRpbWUsICJXaW5kRmFybUF2Z1dpbmRTcGVlZCIsIFdpbmRGYXJtQXZnV2luZFNwZWVkLA0KCQkJY3VyclRpbWUsICJUdXJiaW5lQ291bnRQb3dlclByb2QiLCBUdXJiaW5lQ291bnRQb3dlclByb2QsDQoJCQljdXJyVGltZSwgIlR1cmJpbmVDb3VudEZhdWx0ZWQiLCBUdXJiaW5lQ291bnRGYXVsdGVkLA0KCQkJY3VyclRpbWUsICJUdXJiaW5lQ291bnRJZGxlIiwgVHVyYmluZUNvdW50SWRsZSwNCgkJCWN1cnJUaW1lLCAiVHVyYmluZUNvdW50RGlzY29ubmVjdGVkIiwgVHVyYmluZUNvdW50RGlzY29ubmVjdGVkKTsNCg0K",
|
||||
"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
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
| 参数名 | 参数类型 | 可选 | 描述 |
|
||||
| ------------- | -------- | ---- |------|
|
||||
| data | String | 否 | 脚本内容(Base64编码) |
|
||||
|
||||
Loading…
Reference in New Issue
Block a user