Sidebar

ru:manual:api:reference:graph:get

graph.get

Описание

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

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

Параметры

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

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

Параметр Тип Описание
graphids строка/массив Возврат графиков только с заданными ID.
groupids строка/массив Возврат только тех графиков, которые принадлежат узлам сети из заданных групп узлов сети.
templateids строка/массив Возврат только тех графиков, которые принадлежат заданным шаблонам.
hostids строка/массив Возврат только тех графиков, которые принадлежат заданным узлам сети.
itemids строка/массив Возврат только тех графиков, которые содержат заданные элементы данных.
templated логический Если задано значение true, возврат только тех графиков, которые принадлежат шаблонам.
inherited логический Если задано значение true, возврат только тех графиков, которые унаследованы от шаблонов.
expandName флаг Раскрытие макросов в имени графика.
selectGroups запрос Возврат свойства groups с группами узлов сети, которым принадлежит график.
selectTemplates запрос Возврат свойства templates с шаблонами, которым принадлежит график.
selectHosts запрос Возврат свойств hosts с узлами сети, которым принадлежит график.
selectItems запрос Возврат свойства items с элементами данных, которые используются в графике.
selectGraphDiscovery запрос Возврат свойства graphDiscovery с объектом обнаружения графика. Объекты обнаружения графика связывают график с прототипом графиков с которого он был создан.

Этот объект имеет следующие свойства:
graphid - (строка) ID графика;
parent_graphid - (строка) ID прототипа графиков, с которого был создан график.
selectGraphItems запрос Возврат свойства gitems с элементами графика, которые используются в графике.
selectDiscoveryRule запрос Возврат свойства discoveryRule с правилом низкоуровневого обнаружения, которое создало график.
filter объект Возврат только тех результатов, которые в точности соответствуют заданному фильтру.

Принимает массив, где ключи являются именами свойств и значения, которые являются либо одним значением, либо массивом сопоставляемых значений.

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

Возможные значения: graphid, name и graphtype.
countOutput логическийЭти параметры являются общими для всех методов get и они описаны в справочных комментариях.
editable логический
excludeSearch логический
limit целое число
output запрос
preservekeys логический
search объект
searchByAny логический
searchWildcardsEnabled логический
sortorder строка/массив
startSearch логический

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

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

  • массив объектов;
  • количество найденных объектов, если используется параметр 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.0000",
            "yaxismax": "100.0000",
            "templateid": "439",
            "show_work_period": "1",
            "show_triggers": "1",
            "graphtype": "0",
            "show_legend": "1",
            "show_3d": "0",
            "percent_left": "0.0000",
            "percent_right": "0.0000",
            "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.0000",
            "yaxismax": "100.0000",
            "templateid": "433",
            "show_work_period": "1",
            "show_triggers": "1",
            "graphtype": "0",
            "show_legend": "1",
            "show_3d": "0",
            "percent_left": "0.0000",
            "percent_right": "0.0000",
            "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.0000",
            "yaxismax": "100.0000",
            "templateid": "387",
            "show_work_period": "1",
            "show_triggers": "0",
            "graphtype": "1",
            "show_legend": "1",
            "show_3d": "0",
            "percent_left": "0.0000",
            "percent_right": "0.0000",
            "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.0000",
            "yaxismax": "0.0000",
            "templateid": "0",
            "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",
            "flags": "4"
        }
    ],
    "id": 1
}

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

Исходный код

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