graph.get

Описание

integer/array graph.get(параметры объекта)

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

Этот метод доступен пользователям любого типа. Разрешения на вызов метода можно отозвать в настройках ролей пользователя. Дополнительную информацию см. в разделе Роли пользователей.

Параметры

(object) Параметры, определяющие требуемый результат.

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

Parameter Type Description
graphids ID/array Возвращать только графики с указанными ID.
groupids ID/array Возвращать только графики, которые принадлежат узлам сети или шаблонам в указанных группах узлов сети или группах шаблонов.
templateids ID/array Возвращать только графики, которые принадлежат указанным шаблонам.
hostids ID/array Возвращать только графики, которые принадлежат указанным узлам сети.
itemids ID/array Возвращать только графики, которые содержат указанные элементы данных.
templated boolean Если установлено значение true, возвращать только графики, которые принадлежат шаблонам.
inherited boolean Если установлено значение true, возвращать только графики, унаследованные от шаблона.
expandName flag Расширять макросы в имени графика.
selectHostGroups query Возвращать свойство hostgroups с группами узлов сети, к которым принадлежит график.
selectTemplateGroups query Возвращать свойство templategroups с группами шаблонов, к которым принадлежит график.
selectTemplates query Возвращать свойство templates с шаблонами, к которым принадлежит график.
selectHosts query Возвращать свойство hosts с узлами сети, к которым принадлежит график.
selectItems query Возвращать свойство items с элементами данных, используемыми в графике.
selectGraphDiscovery query Возвращать свойство graphDiscovery с объектом обнаружения графика. Объект обнаружения графика связывает график с прототипом графика, на основе которого он был создан.

Он имеет следующие свойства:
graphid - (ID) ID графика;
parent_graphid - (ID) ID прототипа графика, на основе которого был создан график;
lastcheck - (timestamp) время, когда график был обнаружен в последний раз;
status - (int) статус обнаружения графика:
0 - (по умолчанию) график обнаружен,
1 - график больше не обнаружен;
ts_delete - (timestamp) время, когда будет удален график, который больше не обнаружен.
selectGraphItems query Возвращать свойство gitems с элементами, используемыми в графике.
selectDiscoveryRule query Возвращать свойство discoveryRule с правилом низкоуровневого обнаружения, которое создало график.
filter object Возвращать только те результаты, которые точно соответствуют заданному фильтру.

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

Не поддерживает свойства с типом данных text.

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

Возможные значения: graphid, name, graphtype.
countOutput boolean Эти параметры описаны в справочном комментарии.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectGroups
(deprecated)		 query Этот параметр устарел, вместо него используйте selectHostGroups или selectTemplateGroups.
Возвращать свойство groups с группами узлов сети и группами шаблонов, к которым принадлежит график.

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

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

  • · массив объектов;
  • · количество извлеченных объектов, если использовался параметр countOutput.

Примеры

Получение графиков с узлов сети

Получить все графики с узла сети "10107" и отсортировать их по имени.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "graph.get",
    "params": {
        "output": "extend",
        "hostids": 10107,
        "sortfield": "name"
    },
    "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.