电站接口

Api接口大约 13 分钟约 4031 字

电站接口

查询电站基础信息

接口地址:/open-api/plant/{plantId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:application/json

接口描述: 查询指定电站的基本信息

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
plantId	查询的电站id	path	true	integer(int64)

响应状态:

状态码	说明
200	OK

响应参数:

参数名称	参数说明	类型
code	状态码	integer(int32)
msg	信息说明	string
data	body	PlantDetail
plantId	电站Id	integer(int64)
plantName	电站名称	string
buildDate	建站日期（yyyy-MM-dd）	string
gridDate	并网日期（yyyy-MM-dd）	string
country	所属国家	string
province	所属省份	string
city	所属城市	string
area	所属区县	string
address	电站所在具体地址	string
longitude	经度	string
latitude	纬度	string
status	电站状态（1：正常 2：离线 3：报警 4：故障 5：自定义报警 6：接入中 7：部分设备离线）	integer(int32)
capacity	电站装机容量（单位：kWp）	number
lastReportTime	电站最后同步数据时间	string

响应示例:

{
  "code": 0,
  "msg": "",
  "data": {
    "plantId": 0,
    "plantName": "",
    "buildDate": "",
    "gridDate": "",
    "country": "",
    "province": "",
    "city": "",
    "area": "",
    "address": "",
    "longitude": "",
    "latitude": "",
    "status": 0,
    "capacity": 0,
    "lastReportTime": ""
  }
}

校准发电量

接口地址:/open-api/plant/adjustPlantElectric

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:application/json

接口描述: 校准指定电站的发电量

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
plantId	电站id	body	true	integer(int64)
plantAdjustList	校准数据列表	body	true	array
plantAdjustId	主键	body	false	integer
plantId	电站id	body	false	integer
adjustType	校准类型, 1.按日校准 2.按月校准 3.按年校准 4.累计校准	body	false	integer
adjustTime	校准影响时间, 1.按日（yyyy-MM-dd） 2.按月 (yyyy-MM) 3.按年 (yyyy), 4.累计(total)	body	false	string
adjustValue	校准值	body	false	number

请求示例:

{
  "plantId": 0,
  "plantAdjustList": [
    {
      "plantAdjustId": 0,
      "plantId": 0,
      "adjustType": 0,
      "adjustTime": "",
      "adjustValue": 0
    }
  ]
}

响应状态:

状态码	说明
200	OK

响应参数:

参数名称	参数说明	类型
code	状态码	integer(int32)
msg	信息说明	string
data	数据值	boolean

响应示例:

{
  "code": 0,
  "msg": "",
  "data": true
}

电站绑定采集器

接口地址:/open-api/plant/bind/device

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:application/json

接口描述: 指定电站绑定采集器

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
plantId	电站id	body	true	integer(int64)
deviceId	设备id	body	false	integer(int64)
deviceSn	sn号	body	true	string

请求示例:

{
  "plantId": 0,
  "deviceId": 0,
  "deviceSn": ""
}

响应状态:

状态码	说明
200	OK

响应参数:

参数名称	参数说明	类型
code	状态码	integer(int32)
msg	信息说明	string
data	数据值	boolean

响应示例:

{
  "code": 0,
  "msg": "",
  "data": true
}

创建电站

接口地址:/open-api/plant/create

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:application/json

接口描述: 新建一个电站

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
locationLat	电站所在的纬度	body	false	number(double)
dipAngle	倾角	body	false	number(double)
province	所属省份	body	true	string
city	所属城市	body	true	string
area	所属区县	body	true	string
address	电站所在详细地址	body	true	string
devices	设备sn号集合	body	true	array
deviceType	设备类型: 1.采集器 2.逆变器	body	true	integer
deviceSn	设备sn	body	true	string
registNo	设备注册码(艾仕维必填)	body	false	string
stationImage	电站图片url集合	body	false	array
plantId	电站Id	body	true	integer(int64)
buildDate	建站日期（yyyy-MM-dd）	body	true	string
azimuthAngle	方位角	body	false	number(double)
installedCapacity	装机容量（kWp）	body	true	integer(int32)
ownerName	业主姓名	body	false	string
plantType	分布式户用1分布式商业2分布式工业3地面电站4	body	false	integer(int32)
electricPrice	度电收益（元/kWh）	body	false	string
gridType	并网类型：分布式全额上网：DISTRIBUTED_FULLY余量上网：EXCESS储能+电网：BATTERY_BACKUP	body	true	string
operationUnit	运营单位名称	body	false	string
gridDate	并网日期(yyyy-MM-dd)	body	true	string
operationPhone	运营单位联系方式	body	false	string
locationLng	电站所在经度	body	false	number(double)
contactPhone	业主联系方式	body	false	string
plantName	电站名称	body	true	string
constructionCost	电站建设成本（单位:元）	body	false	number(double)

请求示例:

{
  "locationLat": 0,
  "dipAngle": 0,
  "province": "",
  "city": "",
  "area": "",
  "address": "",
  "devices": [
    {
      "deviceType": 0,
      "deviceSn": "",
      "registNo": ""
    }
  ],
  "stationImage": [],
  "plantId": 0,
  "buildDate": "",
  "azimuthAngle": 0,
  "installedCapacity": 0,
  "ownerName": "",
  "plantType": 0,
  "electricPrice": "",
  "gridType": "",
  "operationUnit": "",
  "gridDate": "",
  "operationPhone": "",
  "locationLng": 0,
  "contactPhone": "",
  "plantName": "",
  "constructionCost": 0
}

响应状态:

状态码	说明
200	OK

响应参数:

参数名称	参数说明	类型
code	状态码	integer(int32)
msg	信息说明	string
data	数据值	integer(int64)

响应示例:

{
  "code": 0,
  "msg": "",
  "data": 0
}

删除电站

接口地址:/open-api/plant/delete/{plantId}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:application/json

接口描述: 删除指定电站

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
plantId	要删除的电站id	path	true	integer(int64)

响应状态:

状态码	说明
200	OK

响应参数:

参数名称	参数说明	类型
code	状态码	integer(int32)
msg	信息说明	string
data	数据值	boolean

响应示例:

{
  "code": 0,
  "msg": "",
  "data": true
}

获取电站设备列表

接口地址:/open-api/plant/devices/{plantId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:application/json

接口描述: 获取指定电站下所有的设备列表，以树形结构展示

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
plantId	电站id	path	true	integer(int64)

响应状态:

状态码	说明
200	OK

响应参数:

参数名称	参数说明	类型
code	状态码	integer(int32)
msg	信息说明	string
data	数据值	array
collectorId	采集器id	integer(int64)
collectorSn	采集器sn号	string
collectorStatus	采集器状态	integer(int32)
childDevice	设备信息数据	array
deviceId	设备ID	integer
deviceType	设备类型: 1.采集器 2.逆变器 3.电表 4.EPM 5.气象仪	integer
deviceType2	设备类型2: 与 productKey及deviceType2 关联	integer
deviceSn	设备SN	string
firstReportTime	设备首次上电日期	string
ratePower	额定功率	number
status	设备状态: 01.正常 02.离线 3.报警 4.故障 5.自定义报警	integer
productKey	产品代码	string

响应示例:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "collectorId": 0,
      "collectorSn": "",
      "collectorStatus": 0,
      "childDevice": [
        {
          "deviceId": 0,
          "deviceType": 0,
          "deviceType2": 0,
          "deviceSn": "",
          "ratePower": 0,
          "firstReportTime": "",
          "status": 0,
          "productKey": ""
        }
      ]
    }
  ]
}

获取电站历史数据

接口地址:/open-api/plant/history

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:application/json

接口描述: 获取某一个电站的某段时间范围内的历史数据

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
plantId	电站Id	query	true	string
startTime	开始时间：格式为 yyyyMMdd 1.小时级数据，建议开始时间与结束时间的跨度不超过3天，若查询当天，startTime为当天 2.天级数据，若查询当天，startTime为当天 3.月级数据，若查询当月，startTime为当月任意一天，不可为空 4.年级数据，若查询当年，startTime为当年任意一天，不可为空 5.总数据，startTime为有效时间内任意一天，不可为空	query	true	string
endTime	结束时间：格式为 yyyyMMdd 1.小时级数据，建议开始时间与结束时间的跨度不超过3天，若查询当天，endTime为第二天 2.天级数据，若查询当天，endTime为第二天 3.月级数据，若查询当月，endTime为当月任意一天，不可为空 4.年级数据，若查询当年，endTime为当年任意一天，不可为空 5.总数据，endTime为有效时间内任意一天，不可为空	query	true	string
searchType	查询类型： 1.小时级数据 2.天级数据 3.月级数据 4.年级数据 5.总数据	query	true	string

响应状态:

状态码	说明
200	OK

响应参数:

参数名称	参数说明	类型
code	状态码	integer(int32)
msg	信息说明	string
data	数据值	array
plantId	电站Id	integer(int64)
values	电站历史数据集	array
time	1.小时级数据（yyyyMMddHH） 2.天级数据（yyyyMMdd） 3.月级数据（yyyyMM） 4.年级数据（yyyy） 5.总数据（无）	string
electric	电站发电量（单位： kWh）	number

响应示例:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "plantId": 0,
      "values": [
        {
          "time": "",
          "electric": 0
        }
      ]
    }
  ]
}

分页查询电站信息(停止维护)

接口地址:/open-api/plant/page

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:application/json

接口描述: 分页查询电站信息,电站id与电站名称忽略不传，则演变为分页查询本帐号下所有电站基本信息

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
plantId	电站Id，精确查找	query	false	string
plantName	电站名称，支持模糊搜索	query	false	string
page	查询的当前页面，默认为1	query	false	string
size	每页的记录数，默认为20	query	false	string

响应状态:

状态码	说明
200	OK

响应参数:

参数名称	参数说明	类型
code	状态码	integer(int32)
msg	信息说明	string
data	数据值	array
plantId	电站Id	integer(int64)
plantName	电站名称	string
buildDate	建站日期（yyyy-MM-dd）	string
gridDate	并网日期（yyyy-MM-dd）	string
country	所属国家	string
province	所属省份	string
city	所属城市	string
area	所属区县	string
address	电站所在具体地址	string
status	电站状态（1：正常 2：离线 3：报警 4：故障 5：自定义报警 6：接入中 7：部分设备离线）	integer(int32)
capacity	电站装机容量（单位：kWp）	number
dayElectric	日发电量（单位：kWh）	number
totalElectric	总发电量（单位：kWh）	number
lastReportTime	电站最后同步数据时间	string

响应示例:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "plantId": 0,
      "plantName": "",
      "buildDate": "",
      "gridDate": "",
      "country": "",
      "province": "",
      "city": "",
      "area": "",
      "address": "",
      "status": 0,
      "capacity": 0,
      "dayElectric": 0,
      "totalElectric": 0,
      "lastReportTime": ""
    }
  ]
}

分页查询电站信息V2(推荐)

接口地址:/open-api/plant/pageV2

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:application/json

接口描述: 分页查询电站信息,电站id与电站名称忽略不传，则演变为分页查询本帐号下所有电站基本信息，回传数据包含总数、页码等分页信息

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
plantId	电站Id，精确查找	query	false	string
plantName	电站名称，支持模糊搜索	query	false	string
page	查询的当前页面，默认为1	query	false	string
size	每页的记录数，默认为20	query	false	string

响应状态:

状态码	说明
200	OK

响应参数:

参数名称	参数说明	类型
code	状态码	integer(int32)
msg	信息说明	string
data	数据值	object
totalCount	总数	integer
totalPages	总页数	integer
currentPage	当前页	integer
pageSize	每页数量	integer
records	数据值	array
plantId	电站Id	integer(int64)
plantName	电站名称	string
buildDate	建站日期（yyyy-MM-dd）	string
gridDate	并网日期（yyyy-MM-dd）	string
country	所属国家	string
province	所属省份	string
city	所属城市	string
area	所属区县	string
address	电站所在具体地址	string
longitude	经度	number
latitude	纬度	number
status	电站状态（1：正常 2：离线 3：报警 4：故障 5：自定义报警 6：接入中 7：部分设备离线）	integer(int32)
capacity	电站装机容量（单位：kWp）	number
dayElectric	日发电量（单位：kWh）	number
totalElectric	总发电量（单位：kWh）	number
lastReportTime	电站最后同步数据时间	string

响应示例:

{
  "code": 0,
  "msg": "",
  "data": {
    "totalCount": 10,
    "totalPages": 1,
    "currentPage": 1,
    "pageSize": 20,
    "records": [
      {
        "plantId": 0,
        "plantName": "",
        "buildDate": "",
        "gridDate": "",
        "country": "",
        "province": "",
        "city": "",
        "area": "",
        "address": "",
        "longitude": 0,
        "latitude": 0,
        "status": 0,
        "capacity": 0,
        "dayElectric": 0,
        "totalElectric": 0,
        "lastReportTime": ""
      }
    ]
  }
}

获取电站实时数据

接口地址:/open-api/plant/realtime

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:application/json

接口描述: 一次性获取最多20个电站的实时数据

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
plantId	电站Id集合，以英文逗号分割，每个批次20个数值之内	query	true	string

响应状态:

状态码	说明
200	OK

响应参数:

参数名称	参数说明	类型
code	状态码	integer(int32)
msg	信息说明	string
data	数据值	array
plantId	电站Id	integer(int64)
timestamp	数据采集时间戳	string
dayElectric	电站日发电量（单位： kWh）	number
power	采集时间实时发电功率（单位: W）	number

响应示例:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "plantId": 0,
      "timestamp": "",
      "dayElectric": 0,
      "power": 0
    }
  ]
}

电站解绑采集器

接口地址:/open-api/plant/untie/device

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:application/json

接口描述: 指定电站解绑采集器

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
plantId	电站id	body	true	integer(int64)
deviceId	设备id	body	false	integer(int64)
deviceSn	sn号	body	true	string

请求示例:

{
  "plantId": 0,
  "deviceId": 0,
  "deviceSn": ""
}

响应状态:

状态码	说明
200	OK

响应参数:

参数名称	参数说明	类型
code	状态码	integer(int32)
msg	信息说明	string
data	数据值	boolean

响应示例:

{
  "code": 0,
  "msg": "",
  "data": true
}

修改电站

接口地址:/open-api/plant/update

请求方式:PUT

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:application/json

接口描述: 更新电站的基本信息

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
locationLat	电站所在的纬度	body	false	number(double)
dipAngle	倾角	body	false	number(double)
province	所属省份	body	true	string
city	所属城市	body	true	string
area	所属区县	body	true	string
address	电站所在详细地址	body	true	string
devices	设备sn号集合	body	true	array
deviceType	设备类型: 1.采集器 2.逆变器	body	true	integer
deviceSn	设备sn	body	true	string
stationImage	电站图片url集合	body	false	array
plantId	电站Id	body	true	integer(int64)
buildDate	建站日期（yyyy-MM-dd）	body	true	string
azimuthAngle	方位角	body	false	number(double)
installedCapacity	装机容量（kWp）	body	true	integer(int32)
ownerName	业主姓名	body	false	string
plantType	分布式户用1分布式商业2分布式工业3地面电站4	body	false	integer(int32)
electricPrice	度电收益（元/kWh）	body	false	string
gridType	并网类型：分布式全额上网：DISTRIBUTED_FULLY余量上网：EXCESS储能+电网：BATTERY_BACKUP	body	true	string
operationUnit	运营单位名称	body	false	string
gridDate	并网日期(yyyy-MM-dd)	body	true	string
operationPhone	运营单位联系方式	body	false	string
locationLng	电站所在经度	body	false	number(double)
contactPhone	业主联系方式	body	false	string
plantName	电站名称	body	true	string
constructionCost	电站建设成本（单位:元）	body	false	number(double)

请求示例:

{
  "locationLat": 0,
  "dipAngle": 0,
  "province": "",
  "city": "",
  "area": "",
  "address": "",
  "devices": [
    {
      "deviceType": 0,
      "deviceSn": ""
    }
  ],
  "stationImage": [],
  "plantId": 0,
  "buildDate": "",
  "azimuthAngle": 0,
  "installedCapacity": 0,
  "ownerName": "",
  "plantType": 0,
  "electricPrice": "",
  "gridType": "",
  "operationUnit": "",
  "gridDate": "",
  "operationPhone": "",
  "locationLng": 0,
  "contactPhone": "",
  "plantName": "",
  "constructionCost": 0
}

响应状态:

状态码	说明
200	OK

响应参数:

参数名称	参数说明	类型
code	状态码	integer(int32)
msg	信息说明	string
data	数据值	boolean

响应示例:

{
  "code": 0,
  "msg": "",
  "data": true
}

电站接口

# 电站接口

# 查询电站基础信息

# 校准发电量

# 电站绑定采集器

# 创建电站

# 删除电站

# 获取电站设备列表

# 获取电站历史数据

# 分页查询电站信息(停止维护)

# 分页查询电站信息V2(推荐)

# 获取电站实时数据

# 电站解绑采集器

# 修改电站

电站接口

查询电站基础信息

校准发电量

电站绑定采集器

创建电站

删除电站

获取电站设备列表

获取电站历史数据

分页查询电站信息(停止维护)

分页查询电站信息V2(推荐)

获取电站实时数据

电站解绑采集器

修改电站