graphprototype.get

Описание

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

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

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

Параметры

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

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

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

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

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

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

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

Возможные значения: graphid, name, graphtype, discovered.
countOutput boolean Эти параметры описаны в комментарии к справочнику.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

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

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

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

Примеры

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

Получить все прототипы графиков из правила LLD.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "graphprototype.get",
    "params": {
        "output": "extend",
        "discoveryids": "27426"
    },
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "graphid": "1017",
            "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",
            "flags": "2",
            "discover": "0"
        }
    ],
    "id": 1
}

См. также

Источник

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