查询告警列表

命令功能

查询系统告警数据，URL参数用于指定本次分页查询控制条件、查询的告警种类和查询操作类型，返回MEF Center数据库中已创建的告警信息。

命令格式

操作类型：GET

URL：https://{ip}:{port}/alarmmanager/v1/alarms?pageNum={value1}&pageSize={value2}&ifCenter={value3}&sn={value4}&groupId={value5}

请求消息体：无

URL参数

表1 参数说明
参数	是否必选	说明	取值要求
pageNum	必选	分页查询取值页数，为序数词	取值最小为1，最大值为2^31-1。
pageSize	必选	分页查询页面大小	取值为1~100的整数。
ifCenter	可选	标志查询节点类型是否为MEF Center节点	取值为true、false或不指定。说明：当ifCenter指定为“true”时，将忽略groupId及sn。当ifCenter指定为“false”，且不提供sn和groupId时，分页查询所有MEF Edge节点告警。
sn	可选，二选一	指定MEF Edge设备序列号可查询该节点上的告警信息	支持小写字母、大写字母，数字，下划线和中划线；不能以下划线或中划线开头和结尾；最大长度为64字节。需为已经存在的序列号。
groupId	可选，二选一	指定groupId可查询该节点组中的所属节点上的告警信息	64位无符号数。取值最小为1，最大值为2^63-1。需为已经存在的groupId。

当ifCenter、sn、groupId三个参数均为空时，按照pageNum和pageSize分页查询所有节点的告警。
当仅有sn或groupId时，ifCenter默认为“false”。

使用样例

请求样例：

GET https://10.10.10.10:30035/alarmmanager/v1/alarms?pageNum=1&pageSize=100&ifCenter=false&sn=xxxxxxxxxxxxxx

请求消息体：无

响应样例：

{
    "status": "00000000",
    "msg": "success",
    "data": {
        "records": [
            {
                "id": 11,
                "alarmType": "alarm",
                "createAt": "2023-08-15T11:58:52.925378602Z",
                "ip": "xx.xx.xx.xx",
                "serialNumber": "xxxxxxxxxxxxxx",
                "resource": "ALARM DEFAULT RESOURCE",
                "severity": "MINOR"
            },
            {
                "id": 19,
                "alarmType": "alarm",
                "createAt": "2023-08-15T11:58:52.984823636Z",
                "ip": "xx.xx.xx.xx",
                "serialNumber": "xxxxxxxxxxxxxx",
                "resource": "ALARM DEFAULT RESOURCE",
                "severity": "MAJOR"
            },
            {
                "id": 2,
                "alarmType": "alarm",
                "createAt": "2023-08-15T11:58:52.851741078Z",
                "ip": "xx.xx.xx.xx",
                "serialNumber": "xxxxxxxxxxxxxx",
                "resource": "ALARM DEFAULT RESOURCE",
                "severity": "MAJOR"
            }
        ],
        "total": 3
    }
}

响应状态码：200

输出说明

表2 操作输出说明
参数	类型	参数说明
status	字符串	错误码
msg	字符串	描述信息
data	对象	查询结果

表3 data字段说明
参数	类型	参数说明
records	数组	分页查询的对象键值对
total	数字	本页内查询到的记录数量

表4 records字段说明
参数	类型	参数说明
id	数字	告警序号
alarmType	字符串	告警类型，告警为alarm，事件为event
createAt	字符串	告警创建时间
ip	字符串	设备IP地址
serialNumber	字符串	MEF Edge告警为设备序列号，MEF Center告警为空字符串
resource	字符串	告警来源
severity	字符串	告警等级： MINOR：一般告警 MAJOR：严重告警 CRITICAL：紧急告警

父主题： 告警事件信息接口