报警接口

Api接口大约 7 分钟约 2050 字

报警接口

获取设备报警明细

接口地址:/open-api/alert/{alertId}

请求方式:GET

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

响应数据类型:application/json

接口描述: 获取报警信息详情信息

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
alertId	报警数据id	path	true	integer(int64)

响应状态:

状态码	说明
200	OK

响应参数:

参数名称	参数说明	类型
code	状态码	integer(int32)
msg	信息说明	string
data	body	PlantAlertVO
plantAlertId	主键	integer(int64)
plantId	电站id	integer(int64)
deviceId	电站id	integer(int64)
plantName	电站名称	string
status	状态id：1.未处理；2.已处理；3.已恢复	integer(int32)
statusLabel	状态文本：1.未处理；2.已处理；3.已恢复	string
collectorSn	采集器sn	string
deviceSn	逆变器sn	string
alertLevel	报警等级id: 01.故障 02.警告 03.提示	integer(int32)
alertLevelLabel	报警等级文本: 01.故障 02.警告 03.提示	string
alertName	报警名称	string
alertCode	报警代码	string
alertEffect	报警影响面	integer(int32)
alertEffectLabel	报警影响面文本	string
startTimeOrigin	报警发生时间	string
startTime	报警发生时间	string
endTimeOrigin	报警恢复时间	string
endTime	报警恢复时间	string
startTimeForCharts	报警发生时间	string
endTimeForCharts	报警恢复时间	string
duration	持续时间	string
solution	拟解决方案	string
reason	原因	string
plotDetailsDTO	图表结果集合	PlotDetailsDTO
weather	电站对象信息	PlotItemDTO
unit	指标单位格式	object
type	指标展现形式	object
data	指标实际数据集合	array
device	电站对象信息	PlotItemDTO
unit	指标单位格式	object
type	指标展现形式	object
data	指标实际数据集合	array
plant	电站对象信息	PlotItemDTO
unit	指标单位格式	object
type	指标展现形式	object
data	指标实际数据集合	array
deviceType	设备类型id	integer(int32)
deviceTypeName	设备类型名称	string
timeZoneOffset	时区	integer(int32)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {
		"plantAlertId": 0,
		"plantId": 0,
		"deviceId": 0,
		"plantName": "",
		"status": 0,
		"statusLabel": "",
		"collectorSn": "",
		"deviceSn": "",
		"alertLevel": 0,
		"alertLevelLabel": "",
		"alertName": "",
		"alertCode": "",
		"alertEffect": 0,
		"alertEffectLabel": "",
		"startTimeOrigin": "",
		"startTime": "",
		"endTimeOrigin": "",
		"endTime": "",
		"startTimeForCharts": "",
		"endTimeForCharts": "",
		"duration": "",
		"solution": "",
		"reason": "",
		"plotDetailsDTO": {
			"weather": {
				"unit": {},
				"type": {},
				"data": []
			},
			"device": {
				"unit": {},
				"type": {},
				"data": []
			},
			"plant": {
				"unit": {},
				"type": {},
				"data": []
			}
		},
		"deviceType": 0,
		"deviceTypeName": "",
		"timeZoneOffset": 0
	}
}

分页查询报警历史信息(停止维护)

接口地址:/open-api/alert/alerthis/page

请求方式:GET

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

响应数据类型:application/json

接口描述: 分页查询设备或电站指定时间范围内的所有的报警信息

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
startTime	起始时间（yyyyMMddHH）	query	true	string
endTime	结束时间（yyyyMMddHH）	query	true	string
page	当前页，默认为1	query	false	string
size	每页条数，默认为20	query	false	string
plantId	电站id集合，以英文逗号分割	query	false	string
collectorSn	采集器sn号集合，以英文逗号分割	query	false	string
deviceSn	逆变器sn号集合，以英文逗号分割	query	false	string

响应状态:

状态码	说明
200	OK

响应参数:

参数名称	参数说明	类型
code	状态码	integer(int32)
msg	信息说明	string
data	数据值	array
plantId	电站id	integer(int64)
collectorSn	采集器sn	string
alertId	报警id	integer(int64)
deviceSn	逆变器sn	string
alertType	报警等级: 01.故障 02.警告 03.提示	integer(int32)
alertName	报警名称	string
alertCode	报警代码	string
startTime	起始时间	string(date-time)
status	状态：1.未处理；2.已处理；3.已恢复	integer(int32)
endTime	结束时间	string(date-time)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": [
		{
			"plantId": 0,
			"collectorSn": "",
			"alertId": 0,
			"deviceSn": "",
			"alertType": 0,
			"alertName": "",
			"alertCode": "",
			"startTime": "",
			"status": 0,
			"endTime": ""
		}
	]
}

分页查询报警历史信息V2(推荐)

接口地址:/open-api/alert/alerthis/pageV2

请求方式:GET

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

响应数据类型:application/json

接口描述: 分页查询设备或电站指定时间范围内的所有的报警信息，回传数据包含总数、页码等分页信息

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
startTime	起始时间（yyyyMMddHH）	query	true	string
endTime	结束时间（yyyyMMddHH）	query	true	string
page	当前页，默认为1	query	false	string
size	每页条数，默认为20	query	false	string
plantId	电站id集合，以英文逗号分割	query	false	string
collectorSn	采集器sn号集合，以英文逗号分割	query	false	string
deviceSn	逆变器sn号集合，以英文逗号分割	query	false	string

响应状态:

状态码	说明
200	OK

响应参数:

参数名称	参数说明	类型
code	状态码	integer(int32)
msg	信息说明	string
data	数据值	object
totalCount	总数	integer
totalPages	总页数	integer
currentPage	当前页	integer
pageSize	每页数量	integer
plantId	电站id	integer(int64)
collectorSn	采集器sn	string
alertId	报警id	integer(int64)
deviceSn	逆变器sn	string
alertType	报警等级: 01.故障 02.警告 03.提示	integer(int32)
alertName	报警名称	string
alertCode	报警代码	string
startTime	起始时间	string(date-time)
status	状态：1.未处理；2.已处理；3.已恢复	integer(int32)
endTime	结束时间	string(date-time)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {
      "totalCount": 10,
      "totalPages": 1,
      "currentPage": 1,
      "pageSize": 20,
      "records": [
        {
          "plantId": 0,
          "collectorSn": "",
          "alertId": 0,
          "deviceSn": "",
          "alertType": 0,
          "alertName": "",
          "alertCode": "",
          "startTime": "",
          "status": 0,
          "endTime": ""
        }
      ]
    }
}

获取实时报警信息(停止维护)

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

请求方式:GET

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

响应数据类型:application/json

接口描述: 分页获取设备或电站的实时报警信息

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	当前页	query	false	string
size	每页条数	query	false	string
plantId	电站id集合，以英文逗号分割	query	false	string
collectorSn	采集器sn号集合，以英文逗号分割	query	false	string
deviceSn	逆变器sn号集合，以英文逗号分割	query	false	string

响应状态:

状态码	说明
200	OK

响应参数:

参数名称	参数说明	类型
code	状态码	integer(int32)
msg	信息说明	string
data	数据值	array
plantId	电站id	integer(int64)
collectorSn	采集器sn	string
alertId	报警id	integer(int64)
deviceSn	逆变器sn	string
alertType	报警等级: 01.故障 02.警告 03.提示	integer(int32)
alertName	报警名称	string
alertCode	报警代码	string
startTime	起始时间	string(date-time)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": [
		{
			"plantId": 0,
			"collectorSn": "",
			"alertId": 0,
			"deviceSn": "",
			"alertType": 0,
			"alertName": "",
			"alertCode": "",
			"startTime": ""
		}
	]
}

获取实时报警信息(推荐)

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

请求方式:GET

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

响应数据类型:application/json

接口描述: 分页获取设备或电站的实时报警信息，回传数据包含总数、页码等分页信息

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	当前页	query	false	string
size	每页条数	query	false	string
plantId	电站id集合，以英文逗号分割	query	false	string
collectorSn	采集器sn号集合，以英文逗号分割	query	false	string
deviceSn	逆变器sn号集合，以英文逗号分割	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)
collectorSn	采集器sn	string
alertId	报警id	integer(int64)
deviceSn	逆变器sn	string
alertType	报警等级: 01.故障 02.警告 03.提示	integer(int32)
alertName	报警名称	string
alertCode	报警代码	string
startTime	起始时间	string(date-time)

响应示例:

{
	"code": 0,
	"msg": "",
	"data": {
      "totalCount": 10,
      "totalPages": 1,
      "currentPage": 1,
      "pageSize": 20,
      "records": [
        {
          "plantId": 0,
          "collectorSn": "",
          "alertId": 0,
          "deviceSn": "",
          "alertType": 0,
          "alertName": "",
          "alertCode": "",
          "startTime": ""
        }
      ]
    }
}

报警接口

# 报警接口

# 获取设备报警明细

# 分页查询报警历史信息(停止维护)

# 分页查询报警历史信息V2(推荐)

# 获取实时报警信息(停止维护)

# 获取实时报警信息(推荐)

报警接口

获取设备报警明细

分页查询报警历史信息(停止维护)

分页查询报警历史信息V2(推荐)

获取实时报警信息(停止维护)

获取实时报警信息(推荐)