triggerprototype.get

Описание

целое число/массив triggerprototype.get(объект параметры)

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

Параметры

(объект) Параметры задают желаемый вывод.

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

Параметр	Тип	Описание
active	флаг	Возврат только активированных прототипов триггеров, которые принадлежат узлам сети под наблюдением.
applicationids	строка/массив	Возврат только тех прототипов триггеров, которые содержат элементы данных из заданных групп элементов данных.
discoveryids	строка/массив	Возврат только тех прототипов триггеров, которые принадлежат заданным правилам LLD.
functions	строка/массив	Возврат только тех прототипов триггеров, которые используют заданные функции. Обратитесь к странице поддерживаемых функций триггеров для получения списка поддерживаемых функций.
group	строка	Возврат только тех прототипов триггеров, которые принадлежат узлам сети из группы узлов сети с заданным именем.
groupids	строка/массив	Возврат только тех прототипов триггеров, которые принадлежат узлам сети из заданных групп узлов сети.
host	строка	Возврат только тех прототипов триггеров, которые принадлежат узлу сети с заданным именем.
hostids	строка/массив	Возврат только тех прототипов триггеров, которые принадлежат заданным узлам сети.
inherited	логический	Если задано значение `true`, возвращать только те прототипы триггеров, которые унаследованы из шаблона.
maintenance	логический	Если задано значение `true`, возвращать только активированные прототипы триггера, которые принадлежат узлам сети в обслуживании.
min_severity	целое число	Возврат только тех прототипов триггеров, у которых важность больше или равна заданной важности.
monitored	флаг	Возврат только активированных прототипов триггеров, которые принадлежат узлам сети под наблюдением и содержат только активированные элементы данных.
templated	логический	Если задано значение `true`, возвращать только те прототипы триггеров, которые принадлежат шаблонам.
templateids	строка/массив	Возврат только тех прототипов триггеров, которые принадлежат заданным шаблонам.
triggerids	строка/массив	Возврат прототипов триггеров только с заданными ID.
expandData	флаг	Возврат дополнительных данных о первом узле сети из выражения триггера. Добавление следующих свойств каждому прототипу триггеров: `hostname` - (строка) видимое имя узла сети; `host` - (строка) техническое имя узла сети; `hostid` - (строка) ID узла сети.
expandExpression	флаг	Раскрытие функций и макросов в выражении триггера.
selectDiscoveryRule	запрос	Возврат LLD правила, которому принадлежит прототип триггеров.
selectFunctions	запрос	Возврат функций, которые используются в прототипе триггеров, в свойстве `functions`. Объект функции представляет собой функции, которые используются в выражении триггера, и имеет следующие свойства: `functionid` - (строка) ID функции; `itemid` - (строка) ID элемента данных, который используется в функции; `function` - (строка) имя функции; `parameter` - (строка) переданный параметр в функцию.
selectGroups	запрос	Возврат групп узлов сети, которым принадлежит прототип триггеров, в свойстве `groups`.
selectHosts	запрос	Возврат узлов сети, которым принадлежит прототип триггеров, в свойстве `hosts`.
selectItems	запрос	Возврат элементов данных и прототипов элементов данных, которые содержатся в прототипе триггеров, в свойстве `items`.
filter	объект	Возврат только тех результатов, которые в точности соответствуют заданному фильтру. Принимает массив, где ключи являются именами свойств и значения, которые являются либо одним значением, либо массивом сопоставляемых значений. Поддерживает дополнительные фильтры: `host` - техническое имя узла сети, которому принадлежит прототип триггеров; `hostid` - ID узла сети, которому принадлежит прототип триггеров.
limitSelects	целое число	Ограничение количества записей, возвращаемых подзапросами. Применимо только к следующим подзапросам: `selectHosts` - результаты сортируются по `host`.
sortfield	строка/массив	Сортировка результата в соответствии с заданными свойствами. Возможные значения: `triggerid`, `description`, `status` и `priority`.
countOutput	флаг	Эти параметры являются общими для всех методов `get` и они описаны в справочных комментариях.
editable	логический
excludeSearch	флаг
limit	целое число
nodeids	строка/массив
output	запрос
preservekeys	флаг
search	объект
searchByAny	логический
searchWildcardsEnabled	логический
sortorder	строка/массив
startSearch	флаг

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

(целое число/массив) Возвращает либо:

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

Примеры

Получение прототипов триггеров с правила LLD

Получение всех прототипов триггеров и их функций с правила LLD.

Запрос:

{
           "jsonrpc": "2.0",
           "method": "triggerprototype.get",
           "params": {
               "output": "extend",
               "selectFunctions": "extend",
               "discoveryids": "22450"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Ответ:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "functions": [
                       {
                           "functionid": "12598",
                           "itemid": "22454",
                           "function": "last",
                           "parameter": "0"
                       }
                   ],
                   "triggerid": "13272",
                   "expression": "{12598}<20",
                   "description": "Free inodes is less than 20% on volume {#FSNAME}",
                   "url": "",
                   "status": "0",
                   "priority": "2",
                   "comments": "",
                   "templateid": "0",
                   "type": "0",
                   "flags": "2"
               },
               {
                   "functions": [
                       {
                           "functionid": "13500",
                           "itemid": "22686",
                           "function": "last",
                           "parameter": "0"
                       }
                   ],
                   "triggerid": "13266",
                   "expression": "{13500}<201",
                   "description": "Free disk space is less than 20% on volume {#FSNAME}",
                   "url": "",
                   "status": "0",
                   "priority": "2",
                   "comments": "",
                   "templateid": "0",
                   "type": "0",
                   "flags": "2"
               }
           ],
           "id": 1
       }

Смотрите также

Исходный код

CTriggerPrototype::get() в frontends/php/api/classes/CTriggerPrototype.php.

Documentation