graphprototype.get

Опис

integer/array graphprototype.get(object parameters)

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

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

Параметри

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

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

Параметр	Тип	Опис
discoveryids	рядок/масив	Повертає лише прототипи графів, які належать до заданих правил виявлення.
graphids	string/array	Повертати лише прототипи графів із заданими ідентифікаторами.
groupids	string/array	Повертає лише прототипи графів, які належать хостам у вказаних групах хостів.
hostids	рядок/масив	Повертає лише прототипи графів, які належать вказаним хостам.
inherited	boolean	Якщо встановлено значення `true` повертає лише прототипи графів, успадковані від шаблону.
itemids	рядок/масив	Повертає лише прототипи графів, які містять задані прототипи елементів.
templated	boolean	Якщо встановлено значення `true` повертає лише прототипи графів, які належать до шаблонів.
templateids	рядок/масив	Повертає лише прототипи графів, які належать до вказаних шаблонів.
selectDiscoveryRule	запит	Повернути властивість discoveryRule із правилом LLD, до якого належить прототип графіка.
selectGraphItems	запит	Повертає властивість gitems з елементами графіка, які використовуються в прототипі графіка.
selectGroups	запит	Повернути властивість groups із групами хостів, до яких належить прототип графіка.
selectHosts	запит	Повернути властивість hosts із хостами, до яких належить прототип графіка.
selectItems	query	Повертає властивість `items` з items і item prototypes, що використовуються в прототипі графіка .
selectTemplates	запит	Повернути властивість templates із шаблонами, до яких належить прототип графіка.
фільтр	об'єкт	Повертає лише ті результати, які точно відповідають заданому фільтру. Приймає масив, де ключі є іменами властивостей, а значення є або одним значенням, або масивом значень для порівняння. Підтримує додаткові фільтри: `host` - технічне ім'я хоста, до якого належить прототип графіка; `hostid` - ID хоста, якому належить прототип графіка.
sortfield	рядок/масив	Відсортуйте результат за заданими властивостями. Можливі значення: `graphid`, `name` і `graphtype`.
countOutput	boolean	Ці параметри, які є спільними для всіх методів `get`, детально описані в довідковому коментарі.
редагований	логічний
excludeSearch	boolean
ліміт	ціле
вивід	запит
preservekeys	boolean
пошук	об'єкт
searchByAny	логічний
увімкнено знаки підстановки	логічний
порядок сортування	рядок/масив
почати пошук	логічний

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

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

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

Приклади

Отримання прототипів графів із правила LLD

Отримати всі прототипи графів із правила LLD.

Запит:

{
           "jsonrpc": "2.0",
           "method": "graphprototype.get",
           "params": {
               "output": "extend",
               "discoveryids": "27426"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Відповідь:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "graphid": "1017",
                   "parent_itemid": "27426",
                   "name": "Disk space usage {#FSNAME}",
                   "width": "600",
                   "height": "340",
                   "yaxismin": "0.0000",
                   "yaxismax": "0.0000",
                   "templateid": "442",
                   "show_work_period": "0",
                   "show_triggers": "0",
                   "graphtype": "2",
                   "show_legend": "1",
                   "show_3d": "1",
                   "percent_left": "0.0000",
                   "percent_right": "0.0000",
                   "ymin_type": "0",
                   "ymax_type": "0",
                   "ymin_itemid": "0",
                   "ymax_itemid": "0",
                   "discover": "0"
               }
           ],
           "id": 1
       }

Дивись також

Джерело

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

Documentation