graphprototype.get

Описание

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

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

Параметры

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

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

Параметр	Тип	Описание
discoveryids	строка/массив	Возврат только тех прототипов графиков, которые принадлежат заданным правилам обнаружения.
graphids	строка/массив	Возврат прототипов графиков только с заданными ID.
groupids	строка/массив	Возврат только тех прототипов графиков, которые принадлежат узлам сети из заданных групп узлов сети.
hostids	строка/массив	Возврат только тех прототипов графиков, которые принадлежат заданным узлам сети.
inherited	логический	Если задано значение `true`, возврат только тех прототипов графиков, которые унаследованы от шаблонов.
itemids	строка/массив	Возврат только тех прототипов графиков, которые содержат заданные прототипы элементов данных.
templated	логический	Если задано значение `true`, возврат только тех прототипов графиков, которые принадлежат шаблонам.
templateids	строка/массив	Возврат только тех прототипов графиков, которые принадлежат заданным шаблонам.
selectDiscoveryRule	запрос	Возврат правила LLD, которому принадлежит прототип графиков, в свойстве `discoveryRule`.
selectGraphItems	запрос	Возврат элементов графика, которые используются в прототипе графиков, в свойстве `gitems`.
selectGroups	запрос	Возврат групп узлов сети, которым принадлежит прототип графиков, в свойстве `groups`.
selectHosts	запрос	Возврат узлов сети, которым принадлежит прототип графиков, в свойстве `hosts`.
selectItems	запрос	Возврат элементов данных и прототипов элементов данных, которые используются в прототипе графиков, в свойстве `items`.
selectTemplates	запрос	Возврат шаблонов, которым принадлежит прототип графиков, в свойстве `templates`.
filter	объект	Возврат только тех результатов, которые в точности соответствуют заданному фильтру. Принимает массив, где ключи являются именами свойств и значения, которые являются либо одним значением, либо массивом сопоставляемых значений. Поддерживает дополнительные фильтры: `host` - техническое имя узла сети, которому принадлежит прототип графиков; `hostid` - ID узла сети, которому принадлежит прототип графиков.
sortfield	строка/массив	Сортировка результата в соответствии с заданными свойствами. Возможные значения: `graphid`, `name` и `graphtype`.
countOutput	флаг	Эти параметры являются общими для всех методов `get` и они описаны в справочных комментариях.
editable	логический
excludeSearch	флаг
limit	целое число
output	запрос
preservekeys	флаг
search	объект
searchByAny	логический
searchWildcardsEnabled	логический
sortorder	строка/массив
startSearch	флаг

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

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

массив объектов;
количество найденных объектов, если используется параметр 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"
               }
           ],
           "id": 1
       }

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

Исходный код

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

Documentation

Sidebar

Table of Contents