hostgroup.get

Опис

integer/array hostgroup.get(object parameters)

Метод дозволяє отримати групи хостів за заданими параметрами.

Цей спосіб доступний користувачам будь-якого типу. Дозволи на виклик методу можна скасувати в налаштуваннях ролі користувача. Див. Ролі користувача для отримання додаткової інформації.

Параметри

(object) Параметри, що визначають бажаний результат.

Метод підтримує такі параметри.

Параметр	Тип	Опис
graphids	string/array	Повертати лише групи хостів, які містять хости або шаблони з заданими графіками.
groupids	рядок/масив	Повертає лише групи хостів із заданими ідентифікаторами груп хостів.
hostids	рядок/масив	Повертає лише групи хостів, які містять вказані хости.
maintenanceids	рядок/масив	Повертає лише групи хостів, на які впливає вказане обслуговування.
monitored_hosts	прапорець	Повертати лише групи хостів, які містять контрольовані хости.
real_hosts	прапор	Повертає лише групи хостів, які містять хости.
templated_hosts	прапорець	Повертати лише групи хостів, які містять шаблони.
templateids	рядок/масив	Повертає лише групи хостів, які містять вказані шаблони.
triggerids	рядок/масив	Повертати лише групи хостів, які містять хости або шаблони з заданими тригерами.
with_graphs	flag	Повертати лише групи хостів, які містять хости з графіками.
with_graph_prototypes	прапорець	Повертати лише групи хостів, які містять хости з прототипами графів.
with_hosts_and_templates	flag	Повертати лише групи хостів, які містять шаблони або хостів.
with_httptests	флаг	Повертає лише групи хостів, які містять хости з веб-перевірками. Замінює параметр `with_monitored_httptests`.
with_items	флаг	Повертає лише групи хостів, які містять хости або шаблони з елементами. Замінює параметри `with_monitored_items` і `with_simple_graph_items`.
with_item_prototypes	прапорець	Повертає лише групи хостів, які містять хости з прототипами елементів. Замінює параметр `with_simple_graph_item_prototypes`.
with_simple_graph_item_prototypes	flag	Повертати лише групи хостів, які містять хости з прототипами елементів, які увімкнено для створення та мають числовий тип інформації.
with_monitored_httptests	flag	Повертати лише групи хостів, які містять хости з увімкненими веб-перевірками.
with_monitored_items	flag	Повертає лише групи хостів, які містять хости або шаблони з увімкненими елементами. Замінює параметр `with_simple_graph_items`.
with_monitored_triggers	flag	Повертати лише групи хостів, які містять хости з увімкненими тригерами. Усі елементи, які використовуються в тригері, також мають бути ввімкнені.
with_simple_graph_items	flag	Повертати лише групи хостів, які містять хости з числовими елементами.
with_triggers	прапорець	Повертає лише групи хостів, які містять хости з тригерами. Замінює параметр `with_monitored_triggers`.
selectDiscoveryRule	запит	Повернути властивість discoveryRule із правилом LLD, яке створило групу хостів.
selectGroupDiscovery	запит	Повертає властивість `groupDiscovery` з об’єктом виявлення групи хостів. Об’єкт виявлення групи хостів пов’язує виявлену групу хостів із прототипом групи хостів і має такі властивості: `groupid` - `(рядок)` ідентифікатор виявленої групи хостів; `lastcheck` - `(мітка часу)` час останнього виявлення групи хостів; `name` - `(рядок)` назва прототип групи хостів; `parent_group_prototypeid` - `(рядок)` Ідентифікатор прототипу групи хостів, з якого було створено групу хостів; `ts_delete` - `(мітка часу)` час, коли група хостів, яка більше не виявлено буде видалено.
selectHosts	запит	Повертає властивість hosts із хостами, які належать до групи хостів. Підтримує `count`.
selectTemplates	запит	Повертає властивість templates із шаблонами, які належать до групи хостів. Підтримує `count`.
limitSelects	ціле число	Обмежує кількість записів, що повертаються підвиборами. Застосовується до наступних підвиборів: `selectHosts` - результати будуть відсортовані за `host`; `selectTemplates` - результати буде відсортовано за `хостом`.
sortfield	рядок/масив	Відсортуйте результат за заданими властивостями. Можливі значення: `groupid`, `name`.
countOutput	boolean	Ці параметри, які є спільними для всіх методів `get`, детально описано на сторінці довідковий коментар.
редагований	логічний
excludeSearch	boolean
фільтр	об'єкт
ліміт	ціле
вивід	запит
preservekeys	boolean
пошук	об'єкт
searchByAny	логічний
увімкнено знаки підстановки	логічний
порядок сортування	рядок/масив
почати пошук	логічний

Повернуті значення

(integer/array) Повертає або:

масив об'єктів;
кількість отриманих об'єктів, якщо використовувався параметр countOutput.

Приклади

Отримання даних за іменем

Отримати всі дані про дві групи хостів під назвою «Zabbix servers» і «Linux servers».

Запит:

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

Відповідь:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "groupid": "2",
                   "name": "Linux servers",
                   "internal": "0"
               },
               {
                   "groupid": "4",
                   "name": "Zabbix servers",
                   "internal": "0"
               }
           ],
           "id": 1
       }

Дивись також

Джерело

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

Documentation