描述

    The method allows to retrieve events according to the given parameters. 此方法用于根据给定参数来获取事件

    Parameters

    参数

    (object) Parameters defining the desired output. (对象) 定义所需输出的参数.

    The method supports the following parameters. 此方法支持以下参数：

    参数类型描述
    eventidsstring/array仅返回具有给定ID的事件.
    groupidsstring/array仅返回由属于给定主机组的对象创建的事件.
    hostidsstring/array仅返回由属于给定主机的对象创建的事件。.
    objectidsstring/array仅返回由给定对象创建的事件.
    applicationidsstring/array仅返回属于给定应用程序的对象创建的事件。仅当对象为触发器或监控项时才适用。
    sourceinteger仅返回给定类型的事件.

    有关支持的事件类型的列表，请参阅页面.

    默认值: 0 - 触发器事件.
    objectinteger仅返回由给定类型的对象创建的事件.

    有关支持的对象类型的列表，请参阅事件对象页面.

    默认值: 0 - 触发器.
    acknowledgedboolean如果设置为“true”，则只返回已被确认的事件.
    severitiesinteger/array仅返回符合给定严重程度的事件。仅当对象为触发器时才适用.
    evaltypeinteger标签搜索的规则.

    可能值:
    0 - (默认) 与/或;
    2 - 或.
    tagsobject仅返回具有给定标签的事件. 按标签进行完全匹配;按值搜索时，不区分大小写.
    Format: [{“tag”: “<tag>”, “value”: “<value>”, “operator”: “<operator>”}, …].
    一个空数组会返回所有事件.

    可能的操作类型:
    0 - (默认) 相似(like);
    1 - 相等(equal).
    eventid_fromstring仅返回ID大于或等于给定ID的事件.
    eventid_tillstring仅返回ID小于或等于给定ID的事件.
    time_fromtimestamp仅返回在给定时间时或之后创建的事件.
    time_tilltimestamp仅返回在给定时间时或之前创建的事件.
    valueinteger/array仅返回具有给定值的事件.
    selectHostsquery在 主机 属性下，返回包含创建该事件的对象的主机. 仅支持由触发器、监控项、低级别发现规则生成的事件.
    selectRelatedObjectquery在 相关对象(relatedObject) 属性下，返回创建该事件的对象. 返回的对象类型会依赖于该事件的类型.
    select_alertsquery在 告警 属性下，返回由该事件生成的告警.告警是按反向时间顺序进行排序
    select_acknowledgesquery在 确认 属性下，返回事件的更新. 事件的更新是按反向时间顺序进行排序.

    事件更新对象具有以下属性:
    acknowledgeid - (string) 确认的ID;
    userid - (string) 更新事件的用户的ID;
    eventid - 被更新事件的ID;
    clock - (timestamp) 事件的更新时间;
    message - (string) 消息文本;
    action - (integer) 已执行的更新操作,参考;
    old_severity - (integer) event severity before this update action更新操作之前的事件的严重等级;
    new_severity - (integer) 更新操作之后的事件的严重等级;
    alias - (string) alias of the user that updated the event更新该事件的用户的别名;
    name - (string) 更新该事件的用户的名称;
    surname - (string) 更新该事件的用户的姓氏.

    支持 计数(count).
    selectTagsquery在 标签 属性下，返回事件的标签.
    sortfieldstring/array根据给定属性，对结果进行排序.

    可能值: eventid, objectid 以及 clock.
    countOutputboolean以下参数为get方法通常参数，在参考注释有详细说明.
    editableboolean
    excludeSearchboolean
    filterobject
    limitinteger
    outputquery
    preservekeysboolean
    searchobject
    searchByAnyboolean
    searchWildcardsEnabledboolean
    sortorderstring/array
    startSearchboolean

    返回值

    (integer/array) Returns either:

    • an array of objects;

    • the count of retrieved objects, if the countOutput parameter has been used.

    返回:

    • 一个数组对象;

    Examples

    例子

    Retrieving trigger events

    获取触发器事件

    Retrieve the latest events from trigger “13926.” 从触发器“13926”中获取最新事件

    Request: 请求:

    Response: 响应:

    Retrieving events by time period

    按时间段获取事件

    Retrieve all events that have been created between October 9 and 10, 2012, in reverse chronological order. 在2012-10-9至2012-10-10时间段内，以逆时间顺序获取所有已被创建的事件。

    Request: 请求:

    Response: 响应:

    参考

    Source

    来源

    CEvent::get() in frontends/php/include/classes/api/services/CEvent.php.