hostinterface.get

Описание

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

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

Параметры

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

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

Параметр	Тип	Описание
hostids	строка/массив	Возврат только тех интерфейсов узлов сети, которые используются заданными узлами сети.
interfaceids	строка/массив	Возврат интерфейсов узлов сети только с заданными IDs.
itemids	строка/массив	Возврат только тех интерфейсов узлов сети, которые используются заданными элементами данных.
triggerids	строка/массив	Возврат только тех узлов сети, которые используются элементами данных в заданных триггерах.
selectItems	запрос	Возврат элементов данных, которые используют интерфейс, в свойстве `items`. Поддерживается `count`.
selectHosts	запрос	Возврат узла сети, который использует интерфейс, в виде массива в свойстве `hosts`.
limitSelects	целое число	Ограничение количества записей, возвращаемых подзапросами. Применимо только к следующим подзапросам: `selectItems`.
sortfield	строка/массив	Сортировка результата в соответствии с заданными свойствами. Возможные значения: `interfaceid`, `dns`, `ip`.
countOutput	флаг	Эти параметры являются общими для всех методов `get` и они описаны в справочных комментариях.
editable	логический
excludeSearch	флаг
filter	объект
limit	целое число
output	запрос
preservekeys	флаг
search	объект
searchByAny	логический
searchWildcardsEnabled	логический
sortorder	строка/массив
startSearch	флаг

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

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

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

Примеры

Получение интерфейсов узлов сети

Получение всех данных о интерфейсах, которые используются узлом сети "30057".

Запрос:

{
           "jsonrpc": "2.0",
           "method": "hostinterface.get",
           "params": {
               "output": "extend",
               "hostids": "30057"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Ответ:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "interfaceid": "30050",
                   "hostid": "30057",
                   "main": "1",
                   "type": "1",
                   "useip": "1",
                   "ip": "127.0.0.1",
                   "dns": "",
                   "port": "10050",
                   "bulk": "1"
               },
               {
                   "interfaceid": "30067",
                   "hostid": "30057",
                   "main": "0",
                   "type": "1",
                   "useip": "0",
                   "ip": "",
                   "dns": "localhost",
                   "port": "10050",
                   "bulk": "1"
               },
               {
                   "interfaceid": "30068",
                   "hostid": "30057",
                   "main": "1",
                   "type": "2",
                   "useip": "1",
                   "ip": "127.0.0.1",
                   "dns": "",
                   "port": "161",
                   "bulk": "1"
               }
           ],
           "id": 1
       }

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

Исходный код

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

Documentation

Sidebar

Table of Contents