查询事件列表

命令功能

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

命令格式

操作类型:GET

URLhttps://{ip}:{port}/alarmmanager/v1/events?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可查询该节点组中的所属MEF Edge节点上的事件信息

32位无符号数。取值最小为1,最大值为2^32-1。

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

使用样例

请求样例:

GET https://10.10.10.10:30035/alarmmanager/v1/events?pageNum=1&pageSize=100&ifCenter=false&groupId=1

请求消息体:无

响应样例:
{
    "status": "00000000",
    "msg": "success",
    "data": {
        "records": [
            {
                "id": 1430946159,
                "alarmType": "event",
                "createAt": "2023-09-27T16:01:25Z",
                "ip": "xx.xx.xx.xx",
                "serialNumber": "xxxxxxxxxxxxxx",
                "resource": "ALARM DEFAULT RESOURCE",
                "severity": "MAJOR"
            },
             {
                "id": 628196293,
                "alarmType": "event",
                "createAt": "2023-09-27T16:01:25Z",
                "ip": "xx.xx.xx.xx",
                "serialNumber": "xxxxxxxxxxxxxx",
                "resource": "ALARM DEFAULT RESOURCE",
                "severity": "MAJOR"
            }
        ],
        "total": 2
    }
}

响应状态码:200

输出说明

表2 操作输出说明

参数

类型

参数说明

status

字符串

错误码

msg

字符串

描述信息

data

对象

查询结果

表3 data字段说明

参数

类型

参数说明

records

数组

分页查询的对象数组

total

数字

查询结果总数

表4 records字段说明

参数

类型

参数说明

id

数字

事件序号

alarmType

字符串

事件类型,取值为event

createAt

字符串

事件创建时间

ip

字符串

设备IP地址

serialNumber

字符串

MEF Edge事件为设备序列号,MEF Center事件为空字符串

resource

字符串

该事件来源

severity

字符串

事件等级:

  • MINOR:一般事件
  • MAJOR:严重事件
  • CRITICAL:紧急事件
  • OK:正常事件