SmartPVMS V300R006C00 Interface Reference
SmartPVMS V300R006C00 Interface Reference
SmartPVMS V300R006C00 Interface Reference
V300R006C00
Interface Reference
Issue 01
Date 2018-09-30
and other Huawei trademarks are trademarks of Huawei Technologies Co., Ltd.
All other trademarks and trade names mentioned in this document are the property of their respective
holders.
Notice
The purchased products, services and features are stipulated by the contract made between Huawei and the
customer. All or part of the products, services and features described in this document may not be within the
purchase scope or the usage scope. Unless otherwise specified in the contract, all statements, information,
and recommendations in this document are provided "AS IS" without warranties, guarantees or
representations of any kind, either express or implied.
The information in this document is subject to change without notice. Every effort has been made in the
preparation of this document to ensure accuracy of the contents, but all statements, information, and
recommendations in this document do not constitute a warranty of any kind, express or implied.
Website: http://www.huawei.com
Email: [email protected]
Contents
1 Interface Overview........................................................................................................................ 1
1.1 Interface Access Instructions..........................................................................................................................................1
1.2 Communication Process between Third Party-System and Northbound Interface........................................................ 2
1 Interface Overview
Access privilege
The access privilege to the northbound interface API is independent of third-party user
accounts, and users must apply for it separately.
Access limit
Third-party applications will be limited by one-minute access frequency when accessing the
same northbound interface API.
If a third-party application reaches the limit of access frequency during use, the interface will
return an access frequency error message.
1. Please refer to the Chapter "Northbound Management" in the product document for the
relevant operation procedures of configuring the third-party system information.
2. After configuring the third-party system information, obtain the system number and log
in with the system number.
3. After successful login, initiate a request to obtain data.
Request address
https://XXXXX/thirdData/login
Request mode
HTTP method: POST
Request parameter
Parameter Name Description Data Type Required/
Optional
Message returned
Parameter Name Description Data Type Remarks
Sample
▲ Sample of request URL:
{
"userName": "Renhan",
"systemCode": "Admin@123456"
}
▲ Sample of return:
{
"success": true,
"data": null,
"failCode": 0,
"params": null,
"message": null
}
After the login interface is successfully logged in, the tokenId is returned. This parameter
needs to be reserved. In subsequent data interface requests, the parameter must be put into the
cookie and passed to the management system.
Request address
https://XXXXX/thirdData/getStationList
Request mode
HTTP method: POST
Request parameter
Parameter Name Description Data Type Required/
Optional
- - - -
NOTE
l The list of power station is obtained without any parameter. The power station resources possessed
by the user is obtained from the background according to the three-party login user.
l The precondition for obtaining the list is that the user must be in login status.
Message returned
Parameter Name Description Data Type Remarks
Sample
▲ Sample of request URL:
Null
▲ Sample of return:
▲ Sample of return:
Sample 2:
{
"success": true,
"data": [
{
"stationCode": "BA4372D08E014822AB065017416F254C",
"stationName": "NM Distributed Power Station 1",
"stationAddr": null,
"capacity": 146.5,
"buildState": "3",
"combineType": "2",
"aidType": 0,
"stationLinkman": "",
"linkmanPho": ""
},
{
"stationCode": "5D02E8B40AD342159AC8D8A2BCD4FAB5",
"stationName": " Intelligent Operation and Maintenance Power Station",
"stationAddr": null,
"capacity": 123.3,
"buildState": "3",
"combineType": "1",
"aidType": 0,
"stationLinkman": "",
"linkmanPho": ""
}
],
"failCode": 0,
"params": {
"userId": 14,
"currentTime": 1503046597854
},
"message": null
}
Request address
https://XXXXX/thirdData/getStationRealKpi
Request mode
HTTP method: POST
Request parameter
Parameter Name Description Data Type Required/
Optional
Message returned
Parameter Name Description Data Type Remarks
Sample
▲ Sample of request URL:
{
"stationCodes": "BA4372D08E014822AB065017416F254C,
5D02E8B40AD342159AC8D8A2BCD4FAB5"
}
▲ Sample of return:
▲ Sample of return:
Sample 2:
{
"success": true,
"data": [
{
"dataItemMap": {
"real_health_state": "3",
"day_power": "10000",
"total_power": "900.000",
"day_income": "0.000",
"month_power": "900.000",
"total_income": "2088.000"
},
"stationCode": "BA4372D08E014822AB065017416F254C"
},
{
"dataItemMap": {
"real_health_state": "1",
"day_power": "16770.000",
"total_power": "35100.000",
"day_income": "26832.000",
"month_power": "35100.000",
"total_income": "61152.000"
},
"stationCode": "5D02E8B40AD342159AC8D8A2BCD4FAB5"
}
],
"failCode": 0,
"params": {
"stationCodes": "BA4372D08E014822AB065017416F254C,
5D02E8B40AD342159AC8D8A2BCD4FAB5",
"currentTime": 1503046597854
},
"message": null
}
Request address
https://XXXXX/thirdData/getKpiStationHour
Request mode
HTTP method: POST
Request parameter
Parameter Name Description Data Type Required/
Optional
Message returned
Parameter Name Description Data Type Remarks
Sample
▲ Sample of request URL:
{
"stationCodes": "BA4372D08E014822AB065017416F254C,
5D02E8B40AD342159AC8D8A2BCD4FAB5",
"collectTime": 1501862400000
}
▲ Sample of return:
▲ Sample of return:
},
"stationCode": "5D02E8B40AD342159AC8D8A2BCD4FAB5",
"collectTime": 1501866000000
},
{
"dataItemMap": {
"use_power": null,
"radiation_intensity": 0,
"inverter_power": 0,
"theory_power": 0,
"ongrid_power": null,
"power_profit": 0,
"performance_ratio": null
},
"stationCode": "BA4372D08E014822AB065017416F254C",
"collectTime": 1501873200000
},
{
"dataItemMap": {
"use_power": 0,
"radiation_intensity": 0,
"inverter_power": 0,
"theory_power": 0,
"ongrid_power": 0,
"power_profit": 0,
"performance_ratio": null
},
"stationCode": "5D02E8B40AD342159AC8D8A2BCD4FAB5",
"collectTime": 1501876800000
},
{
"dataItemMap": {
"use_power": 0,
"radiation_intensity": 0,
"inverter_power": 62.4,
"theory_power": 0,
"ongrid_power": 2340,
"power_profit": 3744,
▲ Sample of return:
"performance_ratio": null
},
"stationCode": "5D02E8B40AD342159AC8D8A2BCD4FAB5",
"collectTime": 1501880400000
},
{
"dataItemMap": {
"use_power": 0,
"radiation_intensity": 0.065,
"inverter_power": 620.1,
"theory_power": 1638,
"ongrid_power": 4680,
"power_profit": 7488,
"performance_ratio": 89
},
"stationCode": "5D02E8B40AD342159AC8D8A2BCD4FAB5",
"collectTime": 1501884000000
},
{
"dataItemMap": {
"use_power": 0,
"radiation_intensity": 0.2474,
"inverter_power": 1924.7,
"theory_power": 6234.48,
"ongrid_power": 4680,
"power_profit": 7488,
"performance_ratio": 75.066
},
"stationCode": "5D02E8B40AD342159AC8D8A2BCD4FAB5",
"collectTime": 1501887600000
},
{
"dataItemMap": {
"use_power": null,
"radiation_intensity": 0.2474,
"inverter_power": 0,
"theory_power": 115.546,
"ongrid_power": null,
▲ Sample of return:
"power_profit": 0,
"performance_ratio": 0
},
"stationCode": "BA4372D08E014822AB065017416F254C",
"collectTime": 1501887600000
}
],
"failCode": 0,
"params": {
"stationCodes": "BA4372D08E014822AB065017416F254C,
5D02E8B40AD342159AC8D8A2BCD4FAB5",
"collectTime": 1501862400000,
"currentTime": 1503046597854
},
"message": null
}
Request address
https://XXXXX/thirdData/getKpiStationDay
Request mode
HTTP method: POST
Request parameter
Parameter Name Description Data Type Required/
Optional
NOTE
Message returned
Parameter Name Description Data Type Remarks
Sample
▲ Sample of request URL:
{
"stationCodes": "BA4372D08E014822AB065017416F254C,
5D02E8B40AD342159AC8D8A2BCD4FAB5",
"collectTime": 1501862400000
}
▲ Sample of return:
▲ Sample of return:
"reduction_total_co2": 0.897,
"reduction_total_coal": 0.36,
"theory_power": 659.6,
"ongrid_power": null,
"power_profit": 2088,
"installed_capacity": 467.04,
"perpower_ratio": 1.927,
"inverter_power": 18330,
"reduction_total_tree": 49,
"performance_ratio": 89
},
"stationCode": "BA4372D08E014822AB065017416F254C",
"collectTime": 1501776000000
}
],
"failCode": 0,
"params": {
"stationCodes": "BA4372D08E014822AB065017416F254C,
5D02E8B40AD342159AC8D8A2BCD4FAB5",
"collectTime": 1501862400000,
"currentTime": 1503046597854
},
"message": null
}
Request address
https://XXXXX/thirdData/getKpiStationMonth
Request mode
HTTP method: POST
Request parameter
Parameter Name Description Data Type Required/
Optional
NOTE
Message returned
Parameter Name Description Data Type Remarks
Sample
▲ Sample of request URL:
{
"stationCodes": "BA4372D08E014822AB065017416F254C,
5D02E8B40AD342159AC8D8A2BCD4FAB5",
"collectTime": 1501862400000
}
▲ Sample of return:
▲ Sample of return:
"reduction_total_co2": 0.897,
"reduction_total_coal": 0.36,
"inverter_power": null,
"theory_power": 659.6,
"ongrid_power": null,
"power_profit": 2088,
"installed_capacity": 467.04,
"perpower_ratio": 1.927,
"reduction_total_tree": 49,
"performance_ratio": 89
},
"stationCode": "BA4372D08E014822AB065017416F254C",
"collectTime": 1501516800000
}
],
"failCode": 0,
"params": {
"stationCodes": "BA4372D08E014822AB065017416F254C,
5D02E8B40AD342159AC8D8A2BCD4FAB5",
"collectTime": 1501862400000
},
"message": null
}
Request address
https://XXXXX/thirdData/getKpiStationYear
Request mode
HTTP method: POST
Request parameter
Parameter Name Description Data Type Required/
Optional
Message returned
Parameter Name Description Data Type Remarks
Sample
▲ Sample of request URL:
{
"stationCodes": "BA4372D08E014822AB065017416F254C,
5D02E8B40AD342159AC8D8A2BCD4FAB5",
"collectTime": 1501862400000
}
▲ Sample of return:
▲ Sample of return:
"reduction_total_coal": 0.36,
"inverter_power": null,
"theory_power": 659.6,
"ongrid_power": null,
"power_profit": 2088,
"installed_capacity": 467.04,
"perpower_ratio": 1.927,
"reduction_total_tree": 49,
"performance_ratio": 89
},
"stationCode": "BA4372D08E014822AB065017416F254C",
"collectTime": 1483200000000
}
],
"failCode": 0,
"params": {
"stationCodes": "BA4372D08E014822AB065017416F254C,
5D02E8B40AD342159AC8D8A2BCD4FAB5",
"collectTime": 1501862400000,
"currentTime": 1503046597854
},
"message": null
}
Request address
https://XXXXX/thirdData/getDevList
Request mode
HTTP method: POST
Request parameter
Parameter Name Description Data Type Required/
Optional
Message returned
Parameter Name Description Data Type Remarks
id Equipment ID
(equipment number)
esnCode Equipment SN
number
26 Photovoltaic
grid-connected
cabinet
27 Photovoltaic
grid-connected
screen
37 Pinnet DAQ
38 Household
inverter
39 Energy storage
40 Household
electric meter
Sample
▲ Sample of request URL:
{
"stationCodes": "BA4372D08E014822AB065017416F254C,
5D02E8B40AD342159AC8D8A2BCD4FAB5",
"collectTime": 1501862400000
}
▲ Sample of return:
▲ Sample of return:
"failCode": 0,
"params": {
"stationCodes": "BA4372D08E014822AB065017416F254C,
5D02E8B40AD342159AC8D8A2BCD4FAB5"
},
"message": null
}
Request address
https://XXXXX/thirdData/getDevRealKpi
Request mode
HTTP method: POST
Request parameter
Parameter Name Description Data Type Required/
Optional
NOTE
Message returned
Parameter Name Description Data Type Remarks
Sample
▲ Sample of request URL:
{
"devIds": "214060404588862,213472461631079",
"devTypeId":"1"
}
▲ Sample of return:
▲ Sample of return:
"pv6_i": 0,
"mppt_power": 0,
"pv1_i": 0,
"total_cap": 0,
"ab_u": 0,
"pv7_i": 0,
"pv13_u": 0,
"reactive_power": 0,
"pv10_u": 0,
"pv12_i": 0,
"pv11_i": 0,
"pv3_i": 0,
"pv11_u": 0,
"pv2_i": 0,
"pv13_i": 0,
"power_factor": 0,
"pv12_u": 0,
"pv5_i": 0,
"active_power": 0,
"elec_freq": 0,
"pv10_i": 0,
"pv4_i": 0,
"mppt_4_cap": 0,
"pv4_u": 0,
"close_time": 0,
"day_cap": 0,
"ca_u": 0,
"a_i": 0,
"pv5_u": 0,
"a_u": 0,
"pv3_u": 0,
"pv14_u": 0,
"pv14_i": 0,
"efficiency": 0,
"pv2_u": 0
},
"devId": 213472461631079
},
▲ Sample of return:
{
"dataItemMap": {
"pv7_u": 0,
"pv1_u": 0,
"b_u": 0,
"c_u": 0,
"pv6_u": 0,
"temperature": 0,
"open_time": 0,
"b_i": 0,
"bc_u": 0,
"pv9_u": 0,
"pv8_u": 0,
"c_i": 0,
"mppt_total_cap": 0,
"pv9_i": 0,
"mppt_3_cap": 0,
"run_state": 0,
"mppt_2_cap": 0,
"inverter_state": 0,
"pv8_i": 0,
"mppt_1_cap": 0,
"pv6_i": 0,
"mppt_power": 0,
"pv1_i": 0,
"total_cap": 0,
"ab_u": 0,
"pv7_i": 0,
"pv13_u": 0,
"reactive_power": 0,
"pv10_u": 0,
"pv12_i": 0,
"pv11_i": 0,
"pv3_i": 0,
"pv11_u": 0,
"pv2_i": 0,
"pv13_i": 0,
"power_factor": 0,
▲ Sample of return:
"pv12_u": 0,
"pv5_i": 0,
"active_power": 0,
"elec_freq": 0,
"pv10_i": 0,
"pv4_i": 0,
"mppt_4_cap": 0,
"pv4_u": 0,
"close_time": 0,
"day_cap": 0,
"ca_u": 0,
"a_i": 0,
"pv5_u": 0,
"a_u": 0,
"pv3_u": 0,
"pv14_u": 0,
"pv14_i": 0,
"efficiency": 0,
"pv2_u": 0
},
"devId": 214060404588862
}
],
"failCode": 0,
"params": {
"devIds": "214060404588862,213472461631079",
"devTypeId": "1",
"currentTime": 1503046597854
},
"message": null
}
Request address
https://XXXXX/thirdData/getDevFiveMinutes
Request mode
HTTP method: POST
Request parameter
Parameter Name Description Data Type Required/
Optional
Message returned
Parameter Name Description Data Type Remarks
Sample
▲ Sample of request URL:
{
"devIds": "214060404588862,213472461631079",
"devTypeId":"1",
"collectTime":"1501862400000"
}
▲ Sample of return:
▲ Sample of return:
"mppt_power": 21.962,
"pv1_i": 7.1,
"total_cap": 655.37,
"ab_u": 495.4,
"pv7_i": null,
"pv13_u": null,
"reactive_power": 20.95,
"pv10_u": null,
"pv12_i": null,
"pv11_i": null,
"pv3_i": 7.1,
"pv11_u": null,
"pv2_i": 7.1,
"pv13_i": null,
"power_factor": 0,
"pv12_u": null,
"pv5_i": 7.2,
"active_power": 21.05,
"elec_freq": 50.05,
"pv10_i": null,
"pv4_i": 7,
"mppt_4_cap": null,
"pv4_u": 577.8,
"open_time": null,
"day_cap": 159.26,
"ca_u": 496.9,
"a_i": 24.9,
"pv5_u": 576.1,
"a_u": 286,
"pv3_u": 577.8,
"pv14_u": null,
"pv14_i": null,
"efficiency": null,
"pv2_u": 575.3
},
"devId": 213472461631079,
"collectTime": 1501862400000
},
▲ Sample of return:
{
"dataItemMap": {
"pv7_u": null,
"pv1_u": 575.3,
"b_u": 286.1,
"c_u": 286.9,
"pv6_u": 576.1,
"temperature": 44.6,
"open_time": null,
"b_i": 24.9,
"bc_u": 495.6,
"pv9_u": null,
"pv8_u": null,
"c_i": 25,
"mppt_total_cap": null,
"pv9_i": null,
"mppt_3_cap": null,
"mppt_2_cap": null,
"inverter_state": 512,
"pv8_i": null,
"mppt_1_cap": null,
"pv6_i": 7.1,
"mppt_power": 21.962,
"pv1_i": 7.1,
"total_cap": 655.37,
"ab_u": 495.4,
"pv7_i": null,
"pv13_u": null,
"reactive_power": 20.95,
"pv10_u": null,
"pv12_i": null,
"pv11_i": null,
"pv3_i": 7.1,
"pv11_u": null,
"pv2_i": 7.1,
"pv13_i": null,
"power_factor": 0,
"pv12_u": null,
▲ Sample of return:
"pv5_i": 7.2,
"active_power": 21.05,
"elec_freq": 50.05,
"pv10_i": null,
"pv4_i": 7,
"mppt_4_cap": null,
"pv4_u": 577.8,
"open_time": null,
"day_cap": 159.26,
"ca_u": 496.9,
"a_i": 24.9,
"pv5_u": 576.1,
"a_u": 286,
"pv3_u": 577.8,
"pv14_u": null,
"pv14_i": null,
"efficiency": null,
"pv2_u": 575.3
},
"devId": 213472461631079,
"collectTime": 1501862700000
}
],
"failCode": 0,
"params": {
"devIds": "214060404588862,213472461631079",
"devTypeId": "1",
"collectTime":"1501862400000"
},
"message": null
}
Request address
https://XXXXX/thirdData/getDevKpiHour
Request mode
HTTP method: POST
Request parameter
Parameter Name Description Data Type Required/
Optional
NOTE
Message returned
Parameter Name Description Data Type Remarks
Sample
▲ Sample of request URL:
{
"devIds": "-97080227842871",
"devTypeId":"39",
"collectTime":"1501862400000"
}
▲ Sample of return:
Request address
https://XXXXX/thirdData/getDevKpiDay
Request mode
HTTP method: POST
Request parameter
Parameter Name Description Data Type Required/
Optional
NOTE
Message returned
Parameter Name Description Data Type Remarks
Sample
▲ Sample of request URL:
{
"devIds": "214060404588862,213472461631079",
"devTypeId":"1",
"collectTime":"1501862400000"
}
▲ Sample of return:
▲ Sample of return:
"collectTime": 1501776000000
}
],
"failCode": 0,
"params": {
"devIds": "214060404588862,213472461631079",
"devTypeId": "1",
"collectTime":"1501862400000"
},
"message": null
}
Request address
https://XXXXX/thirdData/getDevKpiMonth
Request mode
HTTP method: POST
Request parameter
Parameter Name Description Data Type Required/
Optional
NOTE
Message returned
Parameter Name Description Data Type Remarks
Sample
▲ Sample of request URL:
{
"devIds": "214060404588862,213472461631079",
"devTypeId":"1",
"collectTime":"1501862400000"
}
▲ Sample of return:
▲ Sample of return:
"devTypeId": "1",
"collectTime":"1501862400000"
},
"message": null
}
Request address
https://XXXXX/thirdData/getDevKpiYear
Request mode
HTTP method: POST
Request parameter
Parameter Name Description Data Type Required/
Optional
Message returned
Parameter Name Description Data Type Remarks
Sample
▲ Sample of request URL:
{
"devIds": "214060404588862,213472461631079",
"devTypeId":"1",
"collectTime":"1501862400000"
}
▲ Sample of return:
Request address
https://XXXXX/thirdData/devOnOff
Request mode
HTTP method: POST
Request parameter
Parameter Name Description Data Type Required/
Optional
NOTE
The precondition of obtaining the data is that the CB interface must be on.
Message returned
Parameter Name Description Data Type Remarks
devId Equipment ID
Sample
▲ Sample of request URL:
{
"devIds":
"213472461631079,214060404588862,207125245743225,203233345311053,1979135969
44096,195345909983611,192244809755604,190647485584332,185319461689122,184248
291398941",
"devTypeId":"1",
"controlType":1
}
▲ Sample of return:
▲ Sample of return:
"devId": 195345909983611,
"controlResult": false
},
{
"devId": 197913596944096,
"controlResult": false
},
{
"devId": 203233345311053,
"controlResult": false
},
{
"devId": 190647485584332,
"controlResult": false
},
{
"devId": 207125245743225,
"controlResult": false
}
],
"failCode": 0,
"params": {
"devIds":
"213472461631079,214060404588862,207125245743225,203233345311053,1979135969
44096,195345909983611,192244809755604,190647485584332,185319461689122,184248
291398941",
"devTypeId": "1",
"controlType": 1
},
"message": null
}
Request address
https://XXXXX/thirdData/devUpgrade
Request mode
HTTP method: POST
Request parameter
Parameter Name Description Data Type Required/
Optional
NOTE
Message returned
Parameter Name Description Data Type Remarks
Sample
▲ Sample of request URL:
{
"devIds": "213472461631079,214060404588862",
"devTypeId":"1"
}
▲ Sample of return:
Request address
https://XXXXX/thirdData/getDevUpgradeInfo
Request mode
HTTP method: POST
Request parameter
Parameter Name Description Data Type Required/
Optional
NOTE
Message returned
Parameter Name Description Data Type Remarks
Sample
▲ Sample of request URL:
{
"devIds": "213472461631079,214060404588862",
"devTypeId":"1"
}
▲ Sample of return:
▲ Sample of return:
"message": null
}
6 20006 There is the equipment that does not match the equipment type in
the incoming equipment.
10 20010 The power station list cannot be empty in the input parameter.
13 20013 The equipment type is wrong and the interface does not support the
operation of related equipment.
Request mode
HTTP method: POST
Request parameter
Parameter Name Description Description
Message returned
Parameter Name Description
Sample
▲Sample:
example:
{"errorMsg":200}
Request mode
HTTP method: POST
Request parameter
Parameter Name Description Description
Message returned
Parameter Name Description
410 This email has not been registered in the management system
Sample
▲Sample:
example:
{"errorMsg":200}
Request mode
HTTP method: POST
Request parameter
Parameter Name Description Description
Message returned
Parameter Name Description
Sample
▲Sample:
example:
{"errorMsg":200}