183 lines
4.6 KiB
Markdown
183 lines
4.6 KiB
Markdown
# 首页
|
|
|
|
## API接口一览表
|
|
|
|
| 接口分类 | 接口描述 | 查询条件 | API接口 | 权限 |
|
|
|--------|----------------|-----------| ---------------------------- | ---------------------------- |
|
|
| 2.1 首页 | 2.1.1风机矩阵 | 实时数据，没有入参 | /api/home/getWindTurbineMatrixData | |
|
|
| | 2.1.2获取风电场实时数据 | 风电场id | /api/home/getWindFarmRealData | |
|
|
|
|
|
|
## 2.1 首页相关接口
|
|
|
|
### 2.1.1 风机矩阵
|
|
|
|
POST 请求接口
|
|
|
|
> /api/home/getWindTurbineMatrixData
|
|
|
|
请求参数
|
|
|
|
无
|
|
|
|
注:实时数据,没有入参
|
|
|
|
返回报文
|
|
|
|
```json
|
|
{
|
|
"code": 200,
|
|
"success": true,
|
|
"data": [
|
|
{
|
|
"irn": "1846101273013739522",
|
|
"name": "A-001",
|
|
"modelId": "1807685851882508289",
|
|
"model": "倍福1.5",
|
|
"belongLine": "线路1",
|
|
"standard": 1,
|
|
"nominalCapacity": 66.23,
|
|
"attributeMap": {
|
|
"iwindspeed": 10.84000015258789,
|
|
"iturbineoperationmode": 6,
|
|
"iyplevel": 0,
|
|
"ikwhthisday": 0,
|
|
"igenpower": 0,
|
|
"gridlostdetected": 0
|
|
}
|
|
}
|
|
],
|
|
"msg": "操作成功"
|
|
}
|
|
```
|
|
返参描述
|
|
|
|
| 参数名 | 参数类型 | 可选 | 描述 |
|
|
| ------------ |---------| ---- |--------|
|
|
| standard | Integer | 否 | 是否标杆 |
|
|
| nominalCapacity | Double | 否 | 容量 |
|
|
| iwindspeed | Double | 否 | 风速 |
|
|
| iyplevel | Double | 否 | 偏航运行模式 |
|
|
| ikwhthisday | Double | 否 | 日发电量 |
|
|
| igenpower | Double | 否 | 有功功率 |
|
|
| gridlostdetected | Double | 否 | 风机电网掉电 |
|
|
|
|
|
|
|
|
|
|
### 2.1.2 获取风电场实时数据
|
|
|
|
POST 请求接口
|
|
|
|
> /api/home/getWindFarmRealData
|
|
|
|
请求参数
|
|
```json
|
|
{
|
|
"windFarmId":1846101273013739522
|
|
}
|
|
```
|
|
入参描述
|
|
|
|
| 参数名 | 参数类型 | 可选 | 描述 |
|
|
| ------------ |------| ---- |------|
|
|
| windFarmId | Long | yes | 风场id |
|
|
|
|
返回报文
|
|
|
|
```json
|
|
{
|
|
"code": 200,
|
|
"success": true,
|
|
"data": {
|
|
"windFarmId": 1848624295633317890,
|
|
"attributeMap": {
|
|
"windfarmactivepower": 111.01,
|
|
"windfarmavgwindspeed": 111.01,
|
|
"windfarmdayoperationhours": 111.01,
|
|
"windfarmmonthoperationhours": 111.01,
|
|
"windfarmdayprodenergy": 111.01,
|
|
"windfarmmonthprodenergy": 111.01,
|
|
"windfarmyearprodenergy": 111.01,
|
|
"windfarmtotalprodenergy": 111.01
|
|
}
|
|
},
|
|
"msg": "操作成功"
|
|
}
|
|
```
|
|
返参描述
|
|
|
|
| 参数名 | 参数类型 | 可选 | 描述 |
|
|
| ------------- |---------| ---- |------|
|
|
| windFarmId | Long | 否 | 风场id |
|
|
| windfarmactivepower | Double | 否 | 功率 |
|
|
| windfarmavgwindspeed | Double | 否 | 平均风速 |
|
|
| windfarmdayoperationhours | Double | 否 | 日利用小时 |
|
|
| windfarmmonthoperationhours | Double | 否 | 月利用小时 |
|
|
| windfarmdayprodenergy | Double | 否 | 日发电量 |
|
|
| windfarmmonthprodenergy | Double | 否 | 月发电量 |
|
|
| windfarmyearprodenergy | Double | 否 | 年发电量 |
|
|
| windfarmtotalprodenergy | Double | 否 | 总发电量 |
|
|
|
|
### 2.1.3 获取风电场历史数据
|
|
|
|
POST 请求接口
|
|
|
|
> /api/home/getHistoryData
|
|
|
|
请求参数
|
|
```json
|
|
{
|
|
"startTime": "123452435324242",
|
|
"endTime": "123452435924242",
|
|
"devices": [
|
|
{
|
|
"deviceId":"129476828342323",
|
|
"attributes":["power","windSpeed"]
|
|
},
|
|
{
|
|
"deviceId":"129476828342324",
|
|
"attributes":["power","dailyUsageHours"]
|
|
}
|
|
],
|
|
"interval": "5m"
|
|
}
|
|
```
|
|
入参描述
|
|
|
|
| 参数名 | 参数类型 | 可选 | 描述 |
|
|
| ------------ | -------- | ---- |------|
|
|
| startTime | String | no | 开始时间戳 |
|
|
| endTime | String | no | 结束时间戳 |
|
|
| devices.deviceId | String | no | 设备ID |
|
|
| devices.attributes | StringArray | no | 要查询实时数据的设备属性列表 |
|
|
| interval | String | yes | 抽样间隔,1a(毫秒),1s(秒),1m(分),1h(小时),1d(天),1w(周)。 忽略或者值为空时，返回原始数据（不抽样） |
|
|
| endTime | String | no | 结束时间戳 |
|
|
返回报文
|
|
|
|
```json
|
|
{
|
|
"code": 200,
|
|
"msg": "操作成功",
|
|
"success": true,
|
|
"data": {
|
|
//设备ID
|
|
"129476828342323":{
|
|
//属性名
|
|
"power": {
|
|
//时间戳列表
|
|
"times": [123452435924242,123452435924342,123452435924442,123452435924542],
|
|
//值列表
|
|
"values": [123.23,35.21,34.56,67]
|
|
} ,
|
|
//属性名
|
|
"windSpeed": {
|
|
"times": [123452435924242,123452435924342,123452435924442,123452435924542],
|
|
"values": [123.23,35.21,34.56,67]
|
|
}
|
|
},
|
|
.......
|
|
}
|
|
}
|
|
```
|