Documentation
Table of Contents
graph.get
Описание
integer/array 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", "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.