graph.get

Описание

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

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

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

Параметры

(object) Параметры, определяющие желаемый вывод.

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

Параметр Тип Описание
graphids ID/array Возвращать только графики с указанными ID.
groupids ID/array Возвращать только графики, принадлежащие узлам сети или шаблонам в указанных группах узлов сети или группах шаблонов.
templateids ID/array Возвращать только графики, принадлежащие указанным шаблонам.
hostids ID/array Возвращать только графики, принадлежащие указанным узлам сети.
itemids ID/array Возвращать только графики, содержащие указанные элементы данных.
templated boolean Если установлено в true, возвращать только графики, принадлежащие шаблонам.
inherited boolean Если установлено в true, возвращать только графики, унаследованные от шаблона.
expandName flag Развернуть макросы в имени графика.
selectDiscoveryData query Возвращать свойство discoveryData с данными объекта обнаружения графика. Объект обнаружения графика связывает обнаруженный график с прототипом графика, на основе которого он был обнаружен.

Имеет следующие свойства:
parent_graphid - (ID) ID прототипа графика, на основе которого был создан график;
status - (int) статус обнаружения графика:
0 - (по умолчанию) график обнаружен,
1 - график больше не обнаруживается;
ts_delete - (timestamp) время, когда график, который больше не обнаруживается, будет удалён.
selectDiscoveryRule query Возвращать свойство discoveryRule с правилом низкоуровневого обнаружения, создавшим график.
selectHostGroups query Возвращать свойство hostgroups с группами узлов сети, к которым принадлежит график.
selectTemplateGroups query Возвращать свойство templategroups с группами шаблонов, к которым принадлежит график.
selectTemplates query Возвращать свойство templates с шаблонами, к которым принадлежит график.
selectHosts query Возвращать свойство hosts с узлами сети, к которым принадлежит график.
selectItems query Возвращать свойство items с элементами данных, используемыми в графике.
selectGraphItems query Возвращать свойство gitems с элементами данных, используемыми в графике.
filter object Возвращать только те результаты, которые точно соответствуют указанному фильтру.

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

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

Поддерживает дополнительные свойства:
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
selectGraphDiscovery query Возвращать свойство graphDiscovery с объектом обнаружения графика. Объекты обнаружения графика связывают график с прототипом графика, на основе которого он был создан.

Этот запрос устарел, используйте вместо него selectDiscoveryData.

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

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

  • · массив объектов;
  • · количество извлеченных объектов, если использовался параметр 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.