[comment]: # ({f8d4c2e5-f8d4c2e5}) # hostgroup.get [comment]: # ({/f8d4c2e5-f8d4c2e5}) [comment]: # ({20294517-08ff22f2}) ### Описание `integer/array hostgroup.get(object parameters)` Метод позволяет получать группы узлов сети в соответствии с заданными параметрами. ::: noteclassic Этот метод доступен пользователям любого типа. Разрешения на вызов метода могут быть отозваны в настройках роли пользователя. Дополнительную информацию см. в разделе [Роли пользователей](/manual/web_interface/frontend_sections/users/user_roles). ::: [comment]: # ({/20294517-08ff22f2}) [comment]: # ({5291ff51-7f042696}) ### Параметры `(object)` Параметры, определяющие требуемый результат. Метод поддерживает следующие параметры. |Parameter|[Type](/manual/api/reference_commentary#data-types)|Description| |--|--|------| |graphids|ID/array|Возвращать только группы узлов сети, которые содержат узлы сети с указанными графиками.| |groupids|ID/array|Возвращать только группы узлов сети с указанными идентификаторами групп узлов сети.| |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`](/manual/api/reference/discoveryrule/object) с правилами LLD, которые обнаружили группу узлов сети.| |selectDiscoveryData|query|Возвращать свойство `discoveryData` с объектами обнаружения группы узлов сети.

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

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

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

Возможные значения: `groupid`, `name`.| |countOutput|boolean|Эти параметры описаны в [справочном комментарии](/manual/api/reference_commentary#common-get-method-parameters).| |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`.| [comment]: # ({/5291ff51-7f042696}) [comment]: # ({07ca11ca-7223bab1}) ### Возвращаемые значения `(integer/array)` Возвращает либо: - массив объектов - количество полученных объектов, если использовался параметр `countOutput` [comment]: # ({/07ca11ca-7223bab1}) [comment]: # ({b41637d2-b41637d2}) ### Примеры [comment]: # ({/b41637d2-b41637d2}) [comment]: # ({6271b06c-8ed2756a}) #### Получение данных по имени Получить все данные о двух группах узлов сети с именами "Zabbix servers" и "Linux servers". [Запрос](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "hostgroup.get", "params": { "output": "extend", "filter": { "name": [ "Zabbix servers", "Linux servers" ] } }, "id": 1 } ``` Ответ: ```json { "jsonrpc": "2.0", "result": [ { "groupid": "2", "name": "Linux servers", "flags": "0", "uuid": "dc579cd7a1a34222933f24f52a68bcd8" }, { "groupid": "4", "name": "Zabbix servers", "flags": "0", "uuid": "6f6799aa69e844b4b3918f779f2abf08" } ], "id": 1 } ``` [comment]: # ({/6271b06c-8ed2756a}) [comment]: # ({6a994b89-e5f0abe1}) ### См. также - [Узел сети](/manual/api/reference/host/object#host) [comment]: # ({/6a994b89-e5f0abe1}) [comment]: # ({1e72ea39-1e72ea39}) ### Источник CHostGroup::get() в *ui/include/classes/api/services/CHostGroup.php*. [comment]: # ({/1e72ea39-1e72ea39})