На странице
trigger.get
Описание
integer/array trigger.get(object parameters)
Этот метод позволяет получать триггеры в соответствии с заданными параметрами.
Этот метод доступен пользователям любого типа. Права на вызов метода могут быть отозваны в настройках роли пользователя. Дополнительную информацию смотрите в разделе Роли пользователей.
Параметры
(object) Параметры, определяющие желаемый вывод.
Метод поддерживает следующие параметры.
| Параметр | Тип | Описание |
|---|---|---|
| triggerids | ID/array | Возвращать только триггеры с указанными ID. |
| groupids | ID/array | Возвращать только триггеры, принадлежащие узлам сети или шаблонам из указанных групп узлов сети или групп шаблонов. |
| templateids | ID/array | Возвращать только триггеры, принадлежащие указанным шаблонам. |
| hostids | ID/array | Возвращать только триггеры, принадлежащие указанным узлам сети. |
| itemids | ID/array | Возвращать только триггеры, содержащие указанные элементы данных. |
| functions | string/array | Возвращать только триггеры, использующие указанные функции. Список поддерживаемых функций см. на странице supported function. |
| 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 - (по умолчанию) And/Or; 2 - Or. |
| tags | array | Возвращать только триггеры с указанными тегами. Формат: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Пустой массив возвращает все триггеры. Возможные значения operator: 0 - (по умолчанию) Contains; 1 - Equals; 2 - Does not contain; 3 - Does not equal; 4 - Exists; 5 - Does not exist. |
| 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. |
| inheritedTags | boolean | Возвращать триггеры, имеющие указанные tags также в шаблоне/узле сети/связанных шаблонах.Возможные значения: true - шаблон/узел сети/связанные шаблоны также должны иметь указанные теги;false - (по умолчанию) теги из шаблона/узла сети/связанных шаблонов игнорируются. |
| selectInheritedTags | query | Возвращать свойство inheritedTags с тегами, унаследованными от шаблонов, связанных шаблонов и узлов сети, а также от элементов данных, на которые ссылаются выражения триггера или восстановления. |
| selectTemplateGroups | query | Возвращать группы шаблонов, к которым принадлежит триггер, в свойстве templategroups. |
| filter | object | Возвращать только те результаты, которые точно соответствуют указанному фильтру. Принимает объект, где ключи — это имена свойств, а значения — либо одиночное значение, либо массив значений для сопоставления. Не поддерживает свойства типа данных text data type.Поддерживает дополнительные свойства: host - техническое имя узла сети, которому принадлежит триггер;hostid - ID узла сети, которому принадлежит триггер. |
| limitSelects | integer | Ограничивает количество записей, возвращаемых подзапросами. Применяется к следующим подзапросам: selectHosts - результаты будут отсортированы по host. |
| sortfield | string/array | Сортировать результат по указанным свойствам. Возможные значения: triggerid, description, status, priority, lastchange, hostname. |
| countOutput | boolean | Эти параметры описаны в reference commentary. |
| 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": "The host uptime is less than 10 minutes",
"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",
"triggerid": "14062",
"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 заняты менее чем на 100%",
"priority": "4"
},
{
"triggerid": "13824",
"description": "Процессы обнаружения Zabbix заняты более чем на 75%",
"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\")}",
"automatic": "1"
},
{
"tag": "error",
"value": "",
"automatic": "1"
}
]
}
],
"id": 1
}
См. также
Источник
CTrigger::get() в ui/include/classes/api/services/CTrigger.php.