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

dhost.get

Опис

integer/array dhost.get(object parameters)

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

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

Параметри

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

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

Параметр Тип Опис
dhostids рядок/масив Повертає лише виявлені хости з указаними ідентифікаторами.
druleids рядок/масив Повертати лише виявлені хости, які були створені за вказаними правилами виявлення.
dserviceids рядок/масив Повертає лише виявлені хости, на яких запущені дані служби.
selectDRules запит Повернути властивість drules із масивом правил виявлення, які виявили хост.
selectDServices запит Повертає властивість dservices із виявленими службами, що працюють на хості.

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

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

Можливі значення: dhostid і druleid.
countOutput boolean Ці параметри, які є спільними для всіх методів get, детально описані в довідковому коментарі.
редагований логічний
excludeSearch boolean
фільтр об'єкт
ліміт ціле
вивід запит
preservekeys boolean
пошук об'єкт
searchByAny логічний
увімкнено знаки підстановки логічний
порядок сортування рядок/масив
почати пошук логічний

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

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

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

Приклади

Отримати виявлені хости за правилом виявлення

Отримати всі хости та виявлені служби, які вони запускають, які були виявлені правилом виявлення "4".

Запит:

{
           "jsonrpc": "2.0",
           "method": "dhost.get",
           "params": {
               "output": "extend",
               "selectDServices": "extend",
               "druleids": "4"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Відповідь:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "dservices": [
                       {
                           "dserviceid": "1",
                           "dhostid": "1",
                           "type": "4",
                           "key_": "",
                           "value": "",
                           "port": "80",
                           "status": "0",
                           "lastup": "1337697227",
                           "lastdown": "0",
                           "dcheckid": "5",
                           "ip": "192.168.1.1",
                           "dns": "station.company.lan"
                       }
                   ],
                   "dhostid": "1",
                   "druleid": "4",
                   "status": "0",
                   "lastup": "1337697227",
                   "lastdown": "0"
               },
               {
                   "dservices": [
                       {
                           "dserviceid": "2",
                           "dhostid": "2",
                           "type": "4",
                           "key_": "",
                           "value": "",
                           "port": "80",
                           "status": "0",
                           "lastup": "1337697234",
                           "lastdown": "0",
                           "dcheckid": "5",
                           "ip": "192.168.1.4",
                           "dns": "john.company.lan"
                       }
                   ],
                   "dhostid": "2",
                   "druleid": "4",
                   "status": "0",
                   "lastup": "1337697234",
                   "lastdown": "0"
               },
               {
                   "dservices": [
                       {
                           "dserviceid": "3",
                           "dhostid": "3",
                           "type": "4",
                           "key_": "",
                           "value": "",
                           "port": "80",
                           "status": "0",
                           "lastup": "1337697234",
                           "lastdown": "0",
                           "dcheckid": "5",
                           "ip": "192.168.1.26",
                           "dns": "printer.company.lan"
                       }
                   ],
                   "dhostid": "3",
                   "druleid": "4",
                   "status": "0",
                   "lastup": "1337697234",
                   "lastdown": "0"
               },
               {
                   "dservices": [
                       {
                           "dserviceid": "4",
                           "dhostid": "4",
                           "type": "4",
                           "key_": "",
                           "value": "",
                           "port": "80",
                           "status": "0",
                           "lastup": "1337697234",
                           "lastdown": "0",
                           "dcheckid": "5",
                           "ip": "192.168.1.7",
                           "dns": "mail.company.lan"
                       }
                   ],
                   "dhostid": "4",
                   "druleid": "4",
                   "status": "0",
                   "lastup": "1337697234",
                   "lastdown": "0"
               }
           ],
           "id": 1
       }

Дивись також

Джерело

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