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

hostinterface.get

Опис

integer/array hostinterface.get(object parameters)

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

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

Параметри

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

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

Параметр Тип Опис
hostids string/array Повертає лише інтерфейси хостів, які використовуються вказаними хостами.
interfaceids string/array Повертає лише інтерфейси хостів із заданими ідентифікаторами.
itemids string/array Повертає лише інтерфейси хостів, які використовуються вказаними елементами.
triggerids string/array Повертати лише інтерфейси хостів, які використовуються елементами в заданих тригерах.
selectItems query Повертає властивість items з елементами, які використовують інтерфейс.

Підтримує count.
selectHosts query Повернути властивість hosts із масивом хостів, які використовують інтерфейс.
limitSelects integer Обмежує кількість записів, що повертаються підвиборами.

Застосовується до таких підвиборів:
selectItems.
sortfield string/array Відсортуйте результат за вказаними властивостями.

Можливі значення: interfaceid, dns, ip.
countOutput boolean Ці параметри, які є спільними для всіх методів get, детально описано на сторінці довідковий коментар.
редагований boolean
excludeSearch boolean
filter object
limit integer
nodeids string/array
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

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

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

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

Приклади

Отримати інтерфейси хоста

Отримати всі дані про інтерфейси, які використовує хост "30057."

Запит:

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

Відповідь:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "interfaceid": "50039",
                   "hostid": "30057",
                   "main": "1",
                   "type": "1",
                   "useip": "1",
                   "ip": "::1",
                   "dns": "",
                   "port": "10050",
                   "available": "0",
                   "error": "",
                   "errors_from": "0",
                   "disable_until": "0",
                   "details": []
               },
               {
                   "interfaceid": "55082",
                   "hostid": "30057",
                   "main": "0",
                   "type": "1",
                   "useip": "1",
                   "ip": "127.0.0.1",
                   "dns": "",
                   "port": "10051",
                   "available": "0",
                   "error": "",
                   "errors_from": "0",
                   "disable_until": "0",
                   "details": {
                       "version": "2",
                       "bulk": "0",
                       "community": "{$SNMP_COMMUNITY}"
                   }
               }
           ],
           "id": 1
       }

Дивись також

Джерело

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