trigger.get

Описание

integer/array trigger.get(параметры объекта)

Метод позволяет получать триггеры по заданным параметрам.

Этот метод доступен пользователям любого типа. Разрешения на вызов метода можно отозвать в настройках ролей пользователя. Дополнительную информацию см. в разделе Роли пользователей.

Параметры

(object) Параметры, определяющие требуемый результат.

Метод поддерживает следующие параметры.

Parameter Type Description
triggerids ID/array Возвращать только триггеры с указанными ID.
groupids ID/array Возвращать только триггеры, которые принадлежат узлам сети или шаблонам из указанных групп узлов сети или групп шаблонов.
templateids ID/array Возвращать только триггеры, которые принадлежат указанным шаблонам.
hostids ID/array Возвращать только триггеры, которые принадлежат указанным узлам сети.
itemids ID/array Возвращать только триггеры, которые содержат указанные элементы данных.
functions string/array Возвращать только триггеры, которые используют указанные функции.

См. страницу поддерживаемые функции для списка поддерживаемых функций.
group string Возвращать только триггеры, которые принадлежат узлам сети или шаблонам из группы узлов сети или группы шаблонов с указанным именем.
host string Возвращать только триггеры, которые принадлежат узлу сети с указанным техническим именем.
inherited boolean Если установлено true, возвращать только триггеры, унаследованные от шаблона.
templated boolean Если установлено true, возвращать только триггеры, которые принадлежат шаблонам.
dependent boolean Если установлено true, возвращать только триггеры, у которых есть зависимости. Если установлено false, возвращать только триггеры, у которых нет зависимостей.
monitored flag Возвращать только включенные триггеры, которые принадлежат контролируемым узлам сети и содержат только включенные элементы данных.
active flag Возвращать только включенные триггеры, которые принадлежат контролируемым узлам сети.
maintenance boolean Если установлено true, возвращать только включенные триггеры, которые принадлежат узлам сети в обслуживании.
withUnacknowledgedEvents flag Возвращать только триггеры с неподтвержденными событиями.
withAcknowledgedEvents flag Возвращать только триггеры со всеми подтвержденными событиями.
withLastEventUnacknowledged flag Возвращать только триггеры, у которых последнее событие не подтверждено.
skipDependent flag Пропускать триггеры в состоянии проблемы, которые зависят от других триггеров. Обратите внимание, что другие триггеры игнорируются, если они отключены, имеют отключенные элементы данных или отключенные узлы сети элементов данных.
lastChangeSince timestamp Возвращать только триггеры, которые изменили свое состояние после указанного времени.
lastChangeTill timestamp Возвращать только триггеры, которые изменили свое состояние до указанного времени.
only_true flag Возвращать только триггеры, которые недавно находились в состоянии проблемы.
min_severity integer Возвращать только триггеры с уровнем серьезности больше или равным указанному.
evaltype integer Метод оценки тегов.

Возможные значения:
0 - (по умолчанию) И;
2 - Или.
tags array Возвращать только триггеры с указанными тегами.
Формат: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Пустой массив возвращает все триггеры.

Возможные значения оператора:
0 - (по умолчанию) Содержит;
1 - Равно;
2 - Не содержит;
3 - Не равно;
4 - Существует;
5 - Не существует.
expandComment flag Расширять макросы в описании триггера.
expandDescription flag Расширять макросы в имени триггера.
expandExpression flag Расширять функции и макросы в выражении триггера.
selectHostGroups query Возвращать группы узлов сети, к которым принадлежит триггер, в свойстве hostgroups.
selectHosts query Возвращать узлы сети, к которым принадлежит триггер, в свойстве hosts.
selectItems query Возвращать элементы данных, содержащиеся в триггере, в свойстве items.
selectFunctions query Возвращать функции, используемые в триггере, в свойстве functions.

Объекты функций представляют функции, используемые в выражении триггера, и имеют следующие свойства:
functionid - (ID) ID функции;
itemid - (ID) ID элемента данных, используемого в функции;
function - (string) имя функции;
parameter - (string) параметр, переданный функции. Параметр запроса в возвращаемой строке заменяется символом $.
selectDependencies query Возвращать триггеры, от которых зависит триггер, в свойстве dependencies.
selectDiscoveryData query Возвращать свойство discoveryData с данными объекта обнаружения триггера. Объект обнаружения триггера связывает обнаруженный триггер с прототипом триггера, из которого он был обнаружен.

Он имеет следующие свойства:
parent_triggerid - (ID) ID прототипа триггера, из которого был создан триггер;
status - (int) статус обнаружения триггера:
0 - (по умолчанию) триггер обнаружен,
1 - триггер больше не обнаружен;
ts_delete - (timestamp) время, когда триггер, который больше не обнаружен, будет удален;
ts_disable - (timestamp) время, когда триггер, который больше не обнаружен, будет отключен;
disable_source - (int) признак того, был ли триггер отключен правилом LLD или вручную:
0 - (по умолчанию) отключен автоматически,
1 - отключен правилом LLD.
selectDiscoveryRule query Возвращать правило обнаружения низкого уровня, которое создало триггер, в свойстве discoveryRule.
selectLastEvent query Возвращать последнее значимое событие триггера в свойстве lastEvent.
selectTags query Возвращать теги триггера в свойстве tags.
selectTemplateGroups query Возвращать группы шаблонов, к которым принадлежит триггер, в свойстве templategroups.
filter object Возвращать только те результаты, которые точно соответствуют указанному фильтру.

Принимает объект, где ключи — это имена свойств, а значения — либо одно значение, либо массив значений для сопоставления.

Не поддерживает свойства с типом данных text.

Поддерживает дополнительные свойства:
host - техническое имя узла сети, к которому принадлежит триггер;
hostid - ID узла сети, к которому принадлежит триггер.
limitSelects integer Ограничивает количество записей, возвращаемых подвыборами.

Применяется к следующим подвыборам:
selectHosts - результаты будут отсортированы по host.
sortfield string/array Сортировать результат по указанным свойствам.

Возможные значения: triggerid, description, status, priority, lastchange, hostname.
countOutput boolean Эти параметры описаны в справочном комментарии.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectTriggerDiscovery query Возвращать объект обнаружения триггера в свойстве triggerDiscovery. Объекты обнаружения триггера связывают триггер с прототипом триггера, из которого он был создан.

Этот запрос устарел, вместо него используйте selectDiscoveryData.

Возвращаемые значения

(integer/array) Возвращает либо:

  • массив объектов;
  • количество полученных объектов, если использован параметр countOutput.

Примеры

Получение данных по ID триггера

Получите все данные и функции, используемые в триггере "14062".

Запрос:

{
    "jsonrpc": "2.0",
    "method": "trigger.get",
    "params": {
        "triggerids": "14062",
        "output": "extend",
        "selectFunctions": "extend"
    },
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "triggerid": "14062",
            "expression": "{13513}<10m",
            "description": "{HOST.NAME} has been restarted (uptime < 10m)",
            "url": "",
            "status": "0",
            "value": "0",
            "priority": "2",
            "lastchange": "0",
            "comments": "Время работы узла сети меньше 10 минут",
            "error": "",
            "templateid": "10016",
            "type": "0",
            "state": "0",
            "flags": "0",
            "recovery_mode": "0",
            "recovery_expression": "",
            "correlation_mode": "0",
            "correlation_tag": "",
            "manual_close": "0",
            "opdata": "",
            "event_name": "",
            "uuid": "",
            "url_name": "",
            "functions": [
                {
                    "functionid": "13513",
                    "itemid": "24350",
                    "parameter": "$",
                    "function": "last"
                }
            ]
        }
    ],
    "id": 1
}

Получение триггеров в состоянии проблемы

Получите ID, имя и уровень серьезности всех триггеров в состоянии проблемы и отсортируйте их по уровню серьезности по убыванию.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "trigger.get",
    "params": {
        "output": [
            "triggerid",
            "description",
            "priority"
        ],
        "filter": {
            "value": 1
        },
        "sortfield": "priority",
        "sortorder": "DESC"
    },
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "triggerid": "13907",
            "description": "Zabbix self-monitoring processes < 100% busy",
            "priority": "4"
        },
        {
            "triggerid": "13824",
            "description": "Zabbix discoverer processes more than 75% busy",
            "priority": "3"
        }
    ],
    "id": 1
}

Получение конкретного триггера с тегами

Получите конкретный триггер с тегами.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "trigger.get",
    "params": {
        "output": [
            "triggerid",
            "description"
        ],
        "selectTags": "extend",
        "triggerids": [
            "17578"
        ]
    },
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "triggerid": "17370",
            "description": "Service status",
            "tags": [
                {
                    "tag": "service",
                    "value": "{{ITEM.VALUE}.regsub(\"Service (.*) has stopped\", \"\\1\")}"
                },
                {
                    "tag": "error",
                    "value": ""
                }
            ]
        }
    ],
    "id": 1
}

См. также

Источник

CTrigger::get() в ui/include/classes/api/services/CTrigger.php.