查询设备故障告警信息

接口描述

默认查询租户下所有设备的告警信息

功能描述

查询设备故障告警信息

访问限制

每个 ip 的限流次数：每分钟 10 次。

请求方式

HTTPS调用

POST https://we.goodwe.com/api/openapi/v1/service/getAlarmList

Header参数

属性	类型	必填	说明
Authorization	String	是	用户token

请求参数

属性	类型	必填	说明
current	Integer	是	当前页（默认1）
size	Integer	是	分页大小（默认20，最大单次500）
startTime	Long	是	开始时间时间戳
endTime	Long	是	结束时间时间戳
stationIdList	List<Long>	否	电站ID集合（查询电站下属设备告警信息）
systemIdList	List<Long>	否	系统ID集合（查询系统下属设备告警信息）
deviceSnList	List<String>	否	设备sn号集合（查询设备告警信息）
isRecovery	Boolean	否	消息状态，false-当前告警 true-历史告警，默认false
eventLevels	List<Interger>	否	事件等级列表(0红色-紧急，1橙色-严重，2黄色-较为严重，3蓝色-一般)
eventCodes	List<String>	否	事件码列表
deviceTemplateCodes	List<String>	否	设备类型列表

返回参数

属性	类型	说明	示例
code	String	请求成功或失败标识，“00000”请求成功，其余code请求失败	-
description	String	请求结果描述	-
data	Object	返回数据	-
data.current	Integer	当前页	1
data.size	Integer	分页大小	500
data.total	Integer	总数	1000
data.dataList	List<Object>	返回数据	-
data.dataList.originId	String	事件id	1730278725189
data.dataList.kafkaUuid	String	事件Kafka_id	event-0-201
data.dataList.tenantId	String	租户id	1659074779652685824
data.dataList.tenantName	String	租户名称	WePinkTeam
data.dataList.deviceId	Long	设备id	1822881651458441216
data.dataList.deviceSn	String	设备物编码sn	4567QRST2345UVWX
data.dataList.deviceName	String	设备名称	储能系统2#（电池簇）
data.dataList.deviceTemplateType	String	设备类型一级	Device
data.dataList.deviceTemplateCode	String	设备类型二级	Store_BMS
data.dataList.systemId	String	系统id	1822870461969727488
data.dataList.systemCode	String	系统编码	4131232131231231
data.dataList.systemName	String	系统名称	苏州-固德威1号综合场站-2号储能系统
data.dataList.stationId	String	场站id	1821371321045614592
data.dataList.stationCode	String	场站编码	4100KHTU236G0297
data.dataList.stationName	String	场站名称	苏州-固德威1号综合场站
data.dataList.occurrenceTime	String	发生时间（时间戳格式）	1730278725189
data.dataList.occurrenceTimeStr	String	发生时间（yyyy-MM-dd格式）	2024-10-30 16:58:45
data.dataList.recoveryTime	String	恢复时间（时间戳格式）	1730427544337
data.dataList.recoveryTimeStr	String	恢复时间（yyyy-MM-dd格式）	2024-11-01 10:19:04
data.dataList.durationTp	String	异常持续时间（毫秒）	148819148
data.dataList.status	Integer	状态	1-持续； 0-结束； -1-失效
data.dataList.eventCode	String	事件码	E-G3-209-8-0002
data.dataList.eventDesc	String	事件含义	电池簇烟感
data.dataList.eventType	String	事件类型	error
data.dataList.eventLevel	Integer	事件等级	0红色-紧急，1橙色-严重，2黄色-较为严重，3蓝色-一般
data.dataList.eventCategoryCode	String	所属事件库编码	3333
data.dataList.eventCategoryDescription	String	所属事件库含义	电池簇告警
data.dataList.eventCategoryInfluence	String	影响范围	securityRisks
data.dataList.payload	String	消息
data.dataList.note	String	备注	批量解除

其他说明

调用示例

请求数据示例

json
{
    "current": 1,
    "size": 500,
    "endTime": 1730711402799,
    "startTime": 1727668800000,
    "systemIdList": [1814212338501419008],
    "stationIdList": ["1845641410984935424","1845641410984935424"],
    "deviceSnList": [],
    "eventLevels":[],
    "isRecovery":false
}

返回数据示例

样例1：返回告警数据成功

json
{
  "code": "00000",
  "description": "成功",
  "data": {
    "dataList": [
      {
        "originId": "1730278725189",
        "kafkaUuid": "event-0-201",
        "tenantId": "1659074779652685824",
        "tenantName": "WePinkTeam",
        "deviceId": "1822881651458441216",
        "deviceName": "储能系统2#（电池簇）",
        "deviceSn": "4567QRST2345UVWX",
        "deviceTemplateCode": "Store_BMS",
        "deviceTemplateType": "Device",
        "systemId": "1822870461969727488",
        "systemCode": "4131232131231231",
        "systemName": "苏州-固德威1号综合场站-2号储能系统",
        "stationId": "1821371321045614592",
        "stationCode": "4100KHTU236G0297",
        "stationName": "苏州-固德威1号综合场站",
        "occurrenceTime": "1730278725189",
        "occurrenceTimeStr": "2024-10-30 16:58:45",
        "recoveryTime": "1730427544337",
        "recoveryTimeStr": "2024-11-01 10:19:04",
        "durationTp": "148819148",
        "status": 0,
        "eventCode": "E-G3-209-8-0002",
        "eventDesc": " 电池簇烟感",
        "eventType": "error",
        "eventLevel": 1,
        "eventCategoryCode": "3333",
        "eventCategoryDescription": "电池簇告警 ",
        "eventCategoryInfluence": "securityRisks",
        "eventTagNameStr": "电池簇烟感",
        "eventTagCodeStr": "333",
        "payload": "{}",
        "note": "批量解除"
      }
    ],
    "size": 500,
    "current": 1,
    "total": 1
  }
}

大纲

接口描述
- 功能描述
- 访问限制
请求方式
调用示例
- 请求数据示例
- 返回数据示例