hostgroup.get

Описание

integer/array hostgroup.get(object parameters)

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

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

Параметры

(object) Параметры, определяющие желаемый вывод.

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

Параметр Тип Описание
graphids ID/array Возвращать только группы узлов сети, которые содержат узлы сети с указанными графиками.
groupids ID/array Возвращать только группы узлов сети с указанными ID групп узлов сети.
hostids ID/array Возвращать только группы узлов сети, которые содержат указанные узлы сети.
maintenanceids ID/array Возвращать только группы узлов сети, на которые влияют указанные обслуживания.
triggerids ID/array Возвращать только группы узлов сети, которые содержат узлы сети с указанными триггерами.
with_graphs boolean Возвращать только группы узлов сети, которые содержат узлы сети с графиками.
with_graph_prototypes boolean Возвращать только группы узлов сети, которые содержат узлы сети с прототипами графиков.
with_hosts boolean Возвращать только группы узлов сети, которые содержат узлы сети.
with_httptests boolean Возвращать только группы узлов сети, которые содержат узлы сети с веб-проверками.

Переопределяет параметр with_monitored_httptests.
with_items boolean Возвращать только группы узлов сети, которые содержат узлы сети с элементами данных.

Переопределяет параметры with_monitored_items и with_simple_graph_items.
with_item_prototypes boolean Возвращать только группы узлов сети, которые содержат узлы сети с прототипами элементов данных.

Переопределяет параметр with_simple_graph_item_prototypes.
with_simple_graph_item_prototypes boolean Возвращать только группы узлов сети, которые содержат узлы сети с прототипами элементов данных, включёнными для создания и имеющими числовой тип информации.
with_monitored_httptests boolean Возвращать только группы узлов сети, которые содержат узлы сети с включёнными веб-проверками.
with_monitored_hosts boolean Возвращать только группы узлов сети, которые содержат отслеживаемые узлы сети.
with_monitored_items boolean Возвращать только группы узлов сети, которые содержат узлы сети с включёнными элементами данных.

Переопределяет параметр with_simple_graph_items.
with_monitored_triggers boolean Возвращать только группы узлов сети, которые содержат узлы сети с включёнными триггерами. Все элементы данных, используемые в триггере, также должны быть включены.
with_simple_graph_items boolean Возвращать только группы узлов сети, которые содержат узлы сети с числовыми элементами данных.
with_triggers boolean Возвращать только группы узлов сети, которые содержат узлы сети с триггерами.

Переопределяет параметр with_monitored_triggers.
selectDiscoveryRules query Возвращать свойство discoveryRules с правилами LLD, которые обнаружили группу узлов сети.
selectDiscoveryData query Возвращать свойство discoveryData с объектами обнаружения группы узлов сети.

Каждый объект обнаружения группы узлов сети представляет собой прототип группы узлов сети, связанный с обнаруженной группой узлов сети, и имеет следующие свойства:
parent_group_prototypeid - (ID) ID прототипа группы узлов сети, из которого была обнаружена группа узлов сети;
name - (string) имя прототипа группы узлов сети;
ts_delete - (timestamp) время, когда группа узлов сети, которая больше не обнаруживается, будет удалена;
status - (int) статус обнаружения группы узлов сети:
0 - (по умолчанию) группа узлов сети обнаружена,
1 - группа узлов сети больше не обнаруживается.
selectHostPrototypes query Возвращать свойство hostPrototypes с прототипами узлов сети, которые обнаружили эту группу узлов сети.
selectHosts query Возвращать свойство hosts с узлами сети, принадлежащими группе узлов сети.

Поддерживает count.
limitSelects integer Ограничивает количество записей, возвращаемых подзапросами.

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

Возможные значения: groupid, name.
countOutput boolean Эти параметры описаны в справочном комментарии.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectGroupDiscoveries query Возвращать свойство groupDiscoveries с объектами обнаружения группы узлов сети.

Каждый объект обнаружения группы узлов сети представляет собой прототип группы узлов сети, связанный с обнаруженной группой узлов сети.

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

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

(integer/array) Возвращает одно из следующего:

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

Примеры

Получение данных по имени

Получите все данные о двух группах узлов сети с именами "Zabbix servers" и "Linux servers".

Запрос:

{
    "jsonrpc": "2.0",
    "method": "hostgroup.get",
    "params": {
        "output": "extend",
        "filter": {
            "name": [
                "Zabbix servers",
                "Linux servers"
            ]
        }
    },
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "groupid": "2",
            "name": "Linux servers",
            "flags": "0",
            "uuid": "dc579cd7a1a34222933f24f52a68bcd8"
        },
        {
            "groupid": "4",
            "name": "Zabbix servers",
            "flags": "0",
            "uuid": "6f6799aa69e844b4b3918f779f2abf08"
        }
    ],
    "id": 1
}

См. также

Источник

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