This is a translation of the original English documentation page. Help us make it better.

host.get

Опис

integer/array host.get(object parameters)

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

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

Параметри

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

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

Параметр Тип Опис
groupids рядок/масив Повертає лише хости, які належать до вказаних груп.
dserviceids рядок/масив Повертає лише хости, пов’язані з даними виявленими службами.
graphids string/array Повертає лише хости, які мають задані графи.
hostids рядок/масив Повертає лише хости з указаними ідентифікаторами хостів.
httptestids string/array Повертає лише ті хости, які мають дані веб-перевірки.
interfaceids string/array Повертає лише хости, які використовують задані інтерфейси.
itemids рядок/масив Повертає лише хости, які мають дані елементи.
maintenanceids рядок/масив Повертає лише хости, на які впливає дане технічне обслуговування.
monitored_hosts прапорець Повертати лише контрольовані хости.
proxy_hosts прапорець Повернути лише проксі.
proxyids рядок/масив Повертає лише хости, які контролюються вказаними проксі-серверами.
templated_hosts прапор Повертає і хости, і шаблони.
templateids рядок/масив Повертати лише ті хости, які пов’язані з заданими шаблонами.
triggerids рядок/масив Повертає лише хости, які мають задані тригери.
with_items прапор Повертає лише хости, які мають елементи.

Замінює параметри with_monitored_items і with_simple_graph_items.
with_item_prototypes прапорець Повертає лише хости, які мають прототипи елементів.

Замінює параметр with_simple_graph_item_prototypes.
with_simple_graph_item_prototypes прапорець Повертати лише хости, які мають прототипи елементів, які ввімкнено для створення та мають числовий тип інформації.
with_graphs flag Повертати лише хости, які мають графіки.
with_graph_prototypes прапорець Повертати лише хости, які мають прототипи графів.
with_httptests флаг Повертає лише хости, які мають веб-перевірки.

Замінює параметр with_monitored_httptests.
with_monitored_httptests flag Повертати лише хости, які ввімкнули веб-перевірки.
with_monitored_items прапорець Повертати лише хости, які ввімкнули елементи.

Замінює параметр with_simple_graph_items.
with_monitored_triggers flag Повертати лише хости, які ввімкнули тригери. Усі елементи, які використовуються в тригері, також мають бути ввімкнені.
with_simple_graph_items flag Повертати лише хости, які мають елементи з числовим типом інформації.
with_triggers прапорець Повертає лише хости, які мають тригери.

Замінює параметр with_monitored_triggers.
withProblemsSuppressed boolean Повертає хости, які мають пригнічені проблеми.

Можливі значення:
null - (за замовчуванням) усі хости;
true - лише хости з пригніченими проблемами;
false - лише хости з непогашеними проблемами.
evaltype integer Правила пошуку тегів.

Можливі значення:
0 - (за замовчуванням) And/Or;
2 - Or.
серйозності ціле число/масив Повернути хости, які мають лише проблеми з заданим рівнем серйозності. Застосовується, лише якщо проблемний об’єкт є тригером.
теги масив/об'єкт Повертати лише хости з заданими тегами. Точна відповідність за тегом і пошук з урахуванням або без урахування регістру за значенням тегу залежно від значення оператора.
Формат: [{"tag": "<tag>", "value": "<value>", " оператор": "<оператор>"}, ...].
Порожній масив повертає всі хости.

Можливі значення оператора:
0 - (за замовчуванням) містить;
1 - Дорівнює;
2 - Не схоже;
3 - Не дорівнює
4 - Існує;
5 - Не існує.
inheritedTags boolean Повертає хости, які вказали теги також у всіх своїх пов’язаних шаблонах. Типове значення:

Можливі значення:
true - пов'язані шаблони також повинні містити tags;
false - (за замовчуванням) пов'язані теги шаблону ігноруються.
selectDiscoveries запит Повернути властивість discoveries із правилами виявлення низького рівня хоста.

Підтримує count.
selectDiscoveryRule запит Повернути властивість discoveryRule із правилом виявлення низького рівня, яке створило хост (з прототипу хосту в моніторингу VMware).
selectGraphs запит Повертає властивість graphs із графіками хоста.

Підтримує count.
selectGroups запит Повернути властивість groups із даними груп хостів, до яких належить хост.
selectHostDiscovery запит Повертає властивість hostDiscovery з даними об’єкта виявлення хосту.

Об’єкт виявлення хосту пов’язує виявлений хост із прототипом хоста або прототипи хоста з правилом LLD і має такі властивості:< br>host - (рядок) хост прототипу хоста;
hostid - (рядок) ідентифікатор виявленого хоста або прототипу хоста;
parent_hostid - (рядок) Ідентифікатор прототипу хоста, з якого було створено хост;
parent_itemid - (рядок) Ідентифікатор правила LLD, яке створило виявлений хост;
lastcheck - (часова позначка) час, коли хост було виявлено востаннє;
ts_delete - (мітка часу) час, коли хост, який більше не виявлено, буде видалено.
selectHttpTests запит Повертає властивість httpTests із веб-сценаріями хосту.

Підтримує count.
selectInterfaces запит Повертає властивість interfaces з інтерфейсами хоста.

Підтримує count.
selectInventory запит Повернути властивість інвентар з даними інвентаризації хоста.
selectItems запит Повертає властивість items з основними елементами.

Підтримує count.
selectMacros запит Повернути властивість макрос із макросами хосту.
selectParentTemplates запит Повертає властивість parentTemplates із шаблонами, з якими пов’язано хост.

Підтримує count.
selectDashboards запит Повернути властивість dashboards.

Підтримує count.
selectTags запит Повернути властивість tags із тегами хоста.
selectInheritedTags запит Повертає властивість inheritedTags із тегами, які є на всіх шаблонах, пов’язаних із хостом.
selectTriggers query Повертає властивість triggers із тригерами хоста.

Підтримує count.
selectValueMaps запит Повернути властивість valuemaps із картами значень хоста.
фільтр об'єкт Повертає лише ті результати, які точно відповідають заданому фільтру.

Приймає масив, де ключі є іменами властивостей, а значення є або одним значенням, або масивом значень для порівняння.

Дозволяє фільтрувати за властивостями інтерфейсу.
limitSelects ціле число Обмежує кількість записів, що повертаються підвиборами.

Застосовується до наступних підвиборів:
selectParentTemplates - результати будуть відсортовані за host;
selectInterfaces;< br>selectItems - відсортовано за ім'ям;
selectDiscoveries - відсортовано за ім'ям;
selectTriggers - відсортовано за описом;
selectGraphs - відсортовано за ім'ям ;
selectDashboards - відсортовано за ім'ям.
пошук об'єкт Повертає результати, які відповідають даному пошуковому запиту зі знаком підстановки.

Приймає масив, де ключі є іменами властивостей, а значення є рядками для пошуку. Якщо не вказано жодних додаткових параметрів, буде виконано пошук ЯК "%…%``.

Дозволяє пошук за властивостями інтерфейсу. Працює тільки з текстовими полями.| |searchInventory|object|Повертає лише ті хости, які мають інвентаризаційні дані, що відповідають даному пошуковому запиту зі знаком підстановки.

На цей параметр впливають ті самі додаткові параметри, що й на
search.| |sortfield|рядок/масив|Відсортуйте результат за заданими властивостями.

Можливі значення:
hostid,host,name,status.| |countOutput|boolean|Ці параметри, які є спільними для всіх методівget`, детально описані в довідковому коментарі.
редагований логічний
excludeSearch boolean
ліміт ціле
вивід запит
preservekeys boolean
searchByAny логічний
увімкнено знаки підстановки логічний
порядок сортування рядок/масив
почати пошук логічний

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

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

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

Приклади

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

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

Запит:

{
           "jsonrpc": "2.0",
           "method": "host.get",
           "params": {
               "filter": {
                   "host": [
                       "Zabbix server",
                       "Linux server"
                   ]
               }
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Відповідь:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "hostid": "10160",
                   "proxy_hostid": "0",
                   "host": "Zabbix server",
                   "status": "0",
                   "lastaccess": "0",
                   "ipmi_authtype": "-1",
                   "ipmi_privilege": "2",
                   "ipmi_username": "",
                   "ipmi_password": "",
                   "maintenanceid": "0",
                   "maintenance_status": "0",
                   "maintenance_type": "0",
                   "maintenance_from": "0",
                   "name": "Zabbix server",
                   "flags": "0",
                   "description": "The Zabbix monitoring server.",
                   "tls_connect": "1",
                   "tls_accept": "1",
                   "tls_issuer": "",
                   "tls_subject": "",
                   "inventory_mode": "1"
               },
               {
                   "hostid": "10167",
                   "proxy_hostid": "0",
                   "host": "Linux server",
                   "status": "0",
                   "lastaccess": "0",
                   "ipmi_authtype": "-1",
                   "ipmi_privilege": "2",
                   "ipmi_username": "",
                   "ipmi_password": "",
                   "maintenanceid": "0",
                   "maintenance_status": "0",
                   "maintenance_type": "0",
                   "maintenance_from": "0",
                   "name": "Linux server",
                   "flags": "0",
                   "description": "",
                   "tls_connect": "1",
                   "tls_accept": "1",
                   "tls_issuer": "",
                   "tls_subject": "",
                   "inventory_mode": "1"
               }
           ],
           "id": 1
       }

Отримання груп вузлів

Отримати імена груп, учасником яких є «Zabbix server», але без даних про сам хост.

Запит:

{
           "jsonrpc": "2.0",
           "method": "host.get",
           "params": {
               "output": ["hostid"],
               "selectGroups": "extend",
               "filter": {
                   "host": [
                       "Zabbix server"
                   ]
               }
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 2
       }

Відповідь:

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

Отримання зв'язаних шаблонів

Отримайте ідентифікатори та назви шаблонів, пов’язаних із хостом «10084».

Запит:

{
           "jsonrpc": "2.0",
           "method": "host.get",
           "params": {
               "output": ["hostid"],
               "selectParentTemplates": [
                   "templateid",
                   "name"
               ],
               "hostids": "10084"
           },
           "id": 1,
           "auth": "70785d2b494a7302309b48afcdb3a401"
       }

Відповідь:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "hostid": "10084",
                   "parentTemplates": [
                       {
                           "name": "Linux",
                           "templateid": "10001"
                       },
                       {
                           "name": "Zabbix Server",
                           "templateid": "10047"
                       }
                   ]
               }
           ],
           "id": 1
       }

Retrieving hosts by template

Retrieve hosts that have the "10001" (Linux by Zabbix agent) template linked to them.

Request:

{
           "jsonrpc": "2.0",
           "method": "host.get",
           "params": {
               "output": ["hostid", "name"],
               "templateids": "10001"
           },
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "templateid": "10001",
                   "hosts": [
                       {
                           "hostid": "10084",
                           "name": "Zabbix server"
                       },
                       {
                           "hostid": "10603",
                           "name": "Host 1"
                       },
                       {
                           "hostid": "10604",
                           "name": "Host 2"
                       }
                   ]
               }
           ],
           "id": 1
       }

Пошук за даними інвентаризації хоста

Отримати хости, які містять «Linux» у полі «ОС» хостів.

Запит:

{
           "jsonrpc": "2.0",
           "method": "host.get",
           "params": {
               "output": [
                   "host"
               ],
               "selectInventory": [
                   "os"
               ],
               "searchInventory": {
                   "os": "Linux"
               }
           },
           "id": 2,
           "auth": "7f9e00124c75e8f25facd5c093f3e9a0"
       }

Відповідь:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "hostid": "10084",
                   "host": "Zabbix server",
                   "inventory": {
                       "os": "Linux Ubuntu"
                   }
               },
               {
                   "hostid": "10107",
                   "host": "Linux server",
                   "inventory": {
                       "os": "Linux Mint"
                   }
               }
           ],
           "id": 1
       }

Пошук за тегами хоста

Отримати хости, які мають тег «Ім’я хоста», що дорівнює «серверу Linux».

Запит:

{
           "jsonrpc": "2.0",
           "method": "host.get",
           "params": {
               "output": ["hostid"],
               "selectTags": "extend",
               "evaltype": 0,
               "tags": [
                   {
                       "tag": "Host name",
                       "value": "Linux server",
                       "operator": 1
                   }
               ]
           },
           "auth": "7f9e00124c75e8f25facd5c093f3e9a0",
           "id": 1
       }

Відповідь:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "hostid": "10085",
                   "tags": [
                       {
                           "tag": "Host name",
                           "value": "Linux server"
                       },
                       {
                           "tag": "OS",
                           "value": "RHEL 7"
                       }
                   ]
               }
           ],
           "id": 1
       }

Отримувати хости, які мають ці теги не лише на рівні хосту, але й у своїх пов’язаних батьківських шаблонах.

Запит:

{
           "jsonrpc": "2.0",
           "method": "host.get",
           "params": {
               "output": ["name"],
               "tags": [{"tag": "A", "value": "1", "operator": "0"}],
               "inheritedTags": true
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Відповідь:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "hostid": "10623",
                   "name": "PC room 1"
               },
               {
                   "hostid": "10601",
                   "name": "Office"
               }
           ],
           "id": 1
       }

Пошук хосту з тегами та тегами шаблону

Отримайте хост із тегами та всі теги, пов’язані з батьківськими шаблонами.

Запит:

{
           "jsonrpc": "2.0",
           "method": "host.get",
           "params": {
               "output": ["name"],
               "hostids": 10502,
               "selectTags": ["tag", "value"],
               "selectInheritedTags": ["tag", "value"]
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Відповідь:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "hostid": "10502",
                   "name": "Desktop",
                   "tags": [
                       {
                           "tag": "A",
                           "value": "1"
                       }
                   ],
                   "inheritedTags": [
                       {
                           "tag": "B",
                           "value": "2"
                       }
                   ]
               }
           ],
           "id": 1
       }

Пошук хостів за серйозністю проблеми

Отримати хости, які мають проблеми "Лихо".

Запит:

{
           "jsonrpc": "2.0",
           "method": "host.get",
           "params": {
               "output": ["name"],
               "severities": 5
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Відповідь:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "hostid": "10160",
                   "name": "Zabbix server"
               }
           ],
           "id": 1
       }

Отримати хости, які мають проблеми "Середній" і "Високий".

Запит:

{
           "jsonrpc": "2.0",
           "method": "host.get",
           "params": {
               "output": ["name"],
               "severities": [3, 4]
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Відповідь:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "hostid": "20170",
                   "name": "Database"
               },
               {
                   "hostid": "20183",
                   "name": "workstation"
               }
           ],
           "id": 1
       }

Дивись також

Джерело

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