Zabbix Documentation 3.4

2.23.04.04.2 (current)In development:4.4 (devel)Unsupported:1.82.02.43.23.4

User Tools

Site Tools


Sidebar

ru:manual:api:reference:host:get

host.get

Description

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

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

Параметры

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

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

ПараметрТипОписание
groupidsстрока/массив Возврат только тех узлов сети, которые принадлежат заданным группам узлов сети.
applicationidsстрока/массив Возврат только тех узлов сети, которые имеют заданные группы элементов данных.
dserviceidsстрока/массив Возврат только тех узлов сети, которые относятся к заданным обнаруженным сервисам.
graphidsстрока/массив Возврат только тех узлов сети, которые имеют заданные графики.
hostidsстрока/массив Возврат узлов сети только с заданными ID узлов сети.
httptestidsстрока/массив Возврат только тех узлов сети, которые имеют заданные веб проверки.
interfaceidsстрока/массив Возврат только тех узлов сети, которые используют заданные интерфейсы.
itemidsстрока/массив Возврат только тех узлов сети, которые имеют заданные элементы данных.
maintenanceidsстрока/массив Возврат только тех узлов сети, на которых действуют заданные обслуживания.
monitored_hostsфлаг Возврат узлов сети только под наблюдением.
proxy_hostsфлаг Возврат только прокси.
proxyidsстрока/массив Возврат только тех узлов сети, которые наблюдаются заданными прокси.
templated_hostsфлаг Возврат как узлов сети, так и шаблонов.
templateidsстрока/массив Возврат только тех узлов сети, к которым присоединены заданные шаблоны.
triggeridsстрока/массив Возврат только тех узлов сети, которые имеют заданные триггеры.
with_itemsфлагВозврат только тех узлов сети, у которых имеются элементы данных.

Переопределяет параметры with_monitored_items и with_simple_graph_items.
with_applicationsфлагВозврат только тех узлов сети, которые имеют группы элементов данных.
with_graphsфлагВозврат только тех узлов сети, которые имеют графики.
with_httptestsфлагВозврат только тех узлов сети, которые имеют веб проверки.

Переопределяет параметр with_monitored_httptests.
with_monitored_httptestsфлагВозврат только тех узлов сети, которые имеют активированные веб проверки.
with_monitored_itemsфлагВозврат только тех узлов сети, которые имеют активированные элементы данных.

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

Переопределяет параметр with_monitored_triggers.
withInventoryфлагВозврат только тех узлов сети, которые имеют данные инвентаризации.
selectGroupsзапросВозврат групп узлов сети, которым принадлежит узел сети, в свойстве groups.
selectApplicationsзапросВозврат групп элементов данных с узла сети в свойстве applications.

Поддерживается count.
selectDiscoveriesзапросВозврат низкоуровневых обнаружений с узла сети в свойстве discoveries.

Поддерживается count.
selectDiscoveryRule запрос Возврат LLD правил, которые создали узел сети, в свойстве discoveryRule.
selectGraphsзапросВозврат графиков с узла сети в свойстве graphs.

Поддерживается count.
selectHostDiscovery запрос Возврат объекта обнаружения узла сети в свойстве hostDiscovery.

Объект обнаружения узлов сети связывает обнаруженный узел сети с прототипом узлов сети или прототипы узлов сети с LLD правилом и имеет следующие свойства:
host - (строка) имя узла сети прототипа узлов сети;
hostid - (строка) ID обнаруженного узла сети или прототипа узлов сети;
parent_hostid - (строка) ID прототипа узлов сети с которого был создан узел сети;
parent_itemid - (строка) ID правила LLD, которое создало обнаруженный узел сети;
lastcheck - (штамп времени) время, когда узел сети был в последний раз обнаружен;
ts_delete - (штамп времени) время, когда более необнаруживаемый узел сети будет удален.
selectHttpTestsзапросВозврат веб-сценариев с узла сети в свойстве httpTests.

Поддерживается count.
selectInterfacesзапросВозврат интерфейсов узла сети в свойстве interfaces.

Поддерживается count.
selectInventoryзапросВозврат данных инвентаризации узла сети с узла сети в свойстве inventory.
selectItemsзапросВозврат элементов данных с узла сети в свойстве items.

Поддерживается count.
selectMacrosзапросВозврат макросов с узла сети в свойстве macros.
selectParentTemplatesзапросВозврат шаблонов, к которым присоединен узел сети, в свойстве parentTemplates.

Поддерживается count.
selectScreensзапросВозврат комплексных экранов с узла сети в свойстве screens.

Поддерживается count.
selectTriggersзапросВозврат триггеров с узла сети в свойстве triggers.

Поддерживается count.
filter объект Возврат только тех результатов, которые в точности соответствуют заданному фильтру.

Принимает массив, где ключи являются именами свойств и значения, которые являются либо одним значением, либо массивом сопоставляемых значений.

Позволяет фильтровать по свойствам интерфейсов.
limitSelects целое число Ограничение количества записей, возвращаемых подзапросами.

Применимо только к следующим подзапросам:
selectParentTemplates - все результаты сортируются по host;
selectInterfaces;
selectItems - сортируются по name;
selectDiscoveries - сортируются по name;
selectTriggers - сортируются по description;
selectGraphs - сортируются по name;
selectApplications - сортируются по name;
selectScreens - сортируются по name.
search объект Возврат результатов, которые соответствуют заданному шаблону поиска.

Принимает массив, где ключи являются именами свойств и значения являются строками по которым производить поиск. Если дополнительные опции не заданы, эта опция выполнит поиск LIKE “%…%”.

Позволяет выполнять поиск по свойствам интерфейсов. Работает только с текстовыми полями.
searchInventory объект Возврат только тех узлов сети, инвентарные данные которых соответствуют заданному шаблону поиска.

Этот параметр зависит от тех же дополнительных параметров что и search.
sortfieldстрока/массив Сортировка результата в соответствии с заданными свойствами.

Возможные значения: hostid, host, name, status.
countOutputлогическийЭти параметры являются общими для всех методов get и они описаны в справочных комментариях.
editable логический
excludeSearch логический
limit целое число
output запрос
preservekeys логический
searchByAny логический
searchWildcardsEnabled логический
sortorder строка/массив
startSearch логический

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

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

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

Примеры

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

Получение всех данных о двух узлах сети с именами “Zabbix server” и “Linux server”.

Запрос:

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

Ответ:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "maintenances": [],
            "hostid": "10160",
            "proxy_hostid": "0",
            "host": "Zabbix server",
            "status": "0",
            "disable_until": "0",
            "error": "",
            "available": "0",
            "errors_from": "0",
            "lastaccess": "0",
            "ipmi_authtype": "-1",
            "ipmi_privilege": "2",
            "ipmi_username": "",
            "ipmi_password": "",
            "ipmi_disable_until": "0",
            "ipmi_available": "0",
            "snmp_disable_until": "0",
            "snmp_available": "0",
            "maintenanceid": "0",
            "maintenance_status": "0",
            "maintenance_type": "0",
            "maintenance_from": "0",
            "ipmi_errors_from": "0",
            "snmp_errors_from": "0",
            "ipmi_error": "",
            "snmp_error": "",
            "jmx_disable_until": "0",
            "jmx_available": "0",
            "jmx_errors_from": "0",
            "jmx_error": "",
            "name": "Zabbix server",
            "description": "The Zabbix monitoring server.",
            "tls_connect": "1",
            "tls_accept": "1",
            "tls_issuer": "",
            "tls_subject": "",
            "tls_psk_identity": "",
            "tls_psk": ""
        },
        {
            "maintenances": [],
            "hostid": "10167",
            "proxy_hostid": "0",
            "host": "Linux server",
            "status": "0",
            "disable_until": "0",
            "error": "",
            "available": "0",
            "errors_from": "0",
            "lastaccess": "0",
            "ipmi_authtype": "-1",
            "ipmi_privilege": "2",
            "ipmi_username": "",
            "ipmi_password": "",
            "ipmi_disable_until": "0",
            "ipmi_available": "0",
            "snmp_disable_until": "0",
            "snmp_available": "0",
            "maintenanceid": "0",
            "maintenance_status": "0",
            "maintenance_type": "0",
            "maintenance_from": "0",
            "ipmi_errors_from": "0",
            "snmp_errors_from": "0",
            "ipmi_error": "",
            "snmp_error": "",
            "jmx_disable_until": "0",
            "jmx_available": "0",
            "jmx_errors_from": "0",
            "jmx_error": "",
            "name": "Linux server",
            "description": "",
            "tls_connect": "1",
            "tls_accept": "1",
            "tls_issuer": "",
            "tls_subject": "",
            "tls_psk_identity": "",
            "tls_psk": ""
        }
    ],
    "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
}

Получение присоединенных шаблонов

Получение ID и имен шаблонов, которые присоединены к узлу сети “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": "Template OS Linux",
                    "templateid": "10001"
                },
                {
                    "name": "Template App Zabbix Server",
                    "templateid": "10047"
                }
            ]
        }
    ],
    "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
}

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

Исходный код

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