graph.get

Опис

integer/array graph.get(object parameters)

Метод дозволяє отримувати графіки за заданими параметрами.

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

Параметри

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

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

Параметр Тип Опис
graphids string/array Повертає лише графіки з заданими ідентифікаторами.
groupids рядок/масив Повертає лише графіки, які належать хостам у вказаних групах хостів.
templateids рядок/масив Повертає лише графи, які належать до вказаних шаблонів.
hostids рядок/масив Повертає лише графіки, які належать вказаним хостам.
itemids рядок/масив Повертає лише графіки, які містять дані елементи.
templated boolean Якщо встановлено значення true, повертати лише графіки, які належать до шаблонів.
inherited boolean Якщо встановлено значення true повертає лише графіки, успадковані від шаблону.
expandName flag Розгортати макроси в назві графіка.
selectGroups запит Повернути властивість groups із групами хостів, до яких належить графік.
selectTemplates запит Повернути властивість templates із шаблонами, до яких належить графік.
selectHosts запит Повернути властивість hosts із хостами, до яких належить графік.
selectItems запит Повернути властивість items з елементами, які використовуються на графіку.
selectGraphDiscovery запит Повернути властивість graphDiscovery з об’єктом виявлення графіка. Об’єкти виявлення графів пов’язують графік із прототипом графа, з якого його було створено.

Він має такі властивості:
graphid - (рядок) ID графіка;
parent_graphid - (рядок) ID прототипу графіка, з якого створено графік.
selectGraphItems запит Повернути властивість gitems з елементами, які використовуються на графіку.
selectDiscoveryRule запит Повернути властивість discoveryRule із правилом виявлення низького рівня, яке створило графік.
фільтр об'єкт Повертає лише ті результати, які точно відповідають заданому фільтру.

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

Підтримує додаткові фільтри:
host - технічна назва хоста, до якого належить графік;
hostid - ID хоста, якому належить графік.
sortfield рядок/масив Відсортуйте результат за заданими властивостями.

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

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

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

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

Приклади

Отримання графіків із хостів

Отримайте всі графіки з хосту "10107" і відсортуйте їх за назвою.

Запит:

{
           "jsonrpc": "2.0",
           "method": "graph.get",
           "params": {
               "output": "extend",
               "hostids": 10107,
               "sortfield": "name"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Відповідь:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "graphid": "612",
                   "name": "CPU jumps",
                   "width": "900",
                   "height": "200",
                   "yaxismin": "0",
                   "yaxismax": "100",
                   "templateid": "439",
                   "show_work_period": "1",
                   "show_triggers": "1",
                   "graphtype": "0",
                   "show_legend": "1",
                   "show_3d": "0",
                   "percent_left": "0",
                   "percent_right": "0",
                   "ymin_type": "0",
                   "ymax_type": "0",
                   "ymin_itemid": "0",
                   "ymax_itemid": "0",
                   "flags": "0"
               },
               {
                   "graphid": "613",
                   "name": "CPU load",
                   "width": "900",
                   "height": "200",
                   "yaxismin": "0",
                   "yaxismax": "100",
                   "templateid": "433",
                   "show_work_period": "1",
                   "show_triggers": "1",
                   "graphtype": "0",
                   "show_legend": "1",
                   "show_3d": "0",
                   "percent_left": "0",
                   "percent_right": "0",
                   "ymin_type": "1",
                   "ymax_type": "0",
                   "ymin_itemid": "0",
                   "ymax_itemid": "0",
                   "flags": "0"
               },
               {
                   "graphid": "614",
                   "name": "CPU utilization",
                   "width": "900",
                   "height": "200",
                   "yaxismin": "0",
                   "yaxismax": "100",
                   "templateid": "387",
                   "show_work_period": "1",
                   "show_triggers": "0",
                   "graphtype": "1",
                   "show_legend": "1",
                   "show_3d": "0",
                   "percent_left": "0",
                   "percent_right": "0",
                   "ymin_type": "1",
                   "ymax_type": "1",
                   "ymin_itemid": "0",
                   "ymax_itemid": "0",
                   "flags": "0"
               },
               {
                   "graphid": "645",
                   "name": "Disk space usage /",
                   "width": "600",
                   "height": "340",
                   "yaxismin": "0",
                   "yaxismax": "0",
                   "templateid": "0",
                   "show_work_period": "0",
                   "show_triggers": "0",
                   "graphtype": "2",
                   "show_legend": "1",
                   "show_3d": "1",
                   "percent_left": "0",
                   "percent_right": "0",
                   "ymin_type": "0",
                   "ymax_type": "0",
                   "ymin_itemid": "0",
                   "ymax_itemid": "0",
                   "flags": "4"
               }
           ],
           "id": 1
       }

Дивись також

Джерело

CGraph::get() у ui/include/classes/api/services/CGraph.php.