discoveryruleprototype.get

Описание

integer/array discoveryruleprototype.get(object parameters)

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

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

Параметры

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

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

Параметр Тип Описание
discoveryids ID/array Возвращать только прототипы правил LLD, принадлежащие указанным правилам LLD или прототипам правил LLD.
itemids ID/array Возвращать только прототипы правил LLD с указанными ID.
groupids ID/array Возвращать только прототипы правил LLD, принадлежащие узлам сети из указанных групп.
hostids ID/array Возвращать только прототипы правил LLD, принадлежащие указанным узлам сети.
inherited boolean Если установлено в true, возвращать только прототипы правил LLD, унаследованные от шаблона.
interfaceids ID/array Возвращать только прототипы правил LLD, использующие указанные интерфейсы узла сети.
monitored boolean Если установлено в true, возвращать только включённые прототипы правил LLD, принадлежащие отслеживаемым узлам сети.
templated boolean Если установлено в true, возвращать только прототипы правил LLD, принадлежащие шаблонам.
templateids ID/array Возвращать только прототипы правил LLD, принадлежащие указанным шаблонам.
selectDiscoveryRule query Возвращать свойство discoveryRule с родительским правилом LLD для прототипа правила LLD.
Будет возвращён пустой ответ, если родительский объект является прототипом правила обнаружения.
selectDiscoveryRulePrototype query Возвращать свойство discoveryRulePrototype с родительским прототипом правила LLD для прототипа правила LLD.
Будет возвращён пустой ответ, если родительский объект является правилом обнаружения (не прототипом).
selectDiscoveryRulePrototypes query Возвращать свойство discoveryRulePrototypes с дочерними прототипами правил LLD, принадлежащими прототипу правила LLD.

Поддерживает count.
selectFilter query Возвращать свойство filter с данными фильтра, используемого прототипом правила LLD.
selectGraphs query Возвращает свойство graphs с прототипами графиков, принадлежащими прототипу правила LLD.

Поддерживает count.
selectHostPrototypes query Возвращать свойство hostPrototypes с прототипами узлов сети, принадлежащими прототипу правила LLD.

Поддерживает count.
selectHosts query Возвращать свойство hosts с массивом узлов сети, которым принадлежит прототип правила LLD.
selectItems query Возвращать свойство items с прототипами элементов данных, принадлежащими прототипу правила LLD.

Поддерживает count.
selectTriggers query Возвращать свойство triggers с прототипами триггеров, принадлежащими прототипу правила LLD.

Поддерживает count.
selectLLDMacroPaths query Возвращать свойство lld_macro_paths со списком макросов LLD и путей к значениям, назначенным каждому соответствующему макросу.
selectPreprocessing query Возвращать свойство preprocessing с параметрами предобработки прототипа правила LLD.
selectOverrides query Возвращать свойство lld_rule_overrides со списком фильтров переопределения, условий и операций, выполняемых над объектами-прототипами.
filter object Возвращать только те результаты, которые точно соответствуют указанному фильтру.

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

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

Поддерживает дополнительные свойства:
host - техническое имя узла сети, которому принадлежит прототип правила LLD.
limitSelects integer Ограничивает количество записей, возвращаемых подзапросами.

Применяется к следующим подзапросам: selectItems, selectGraphs, selectTriggers.
sortfield string/array Сортировать результат по указанным свойствам.

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

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

(integer/array) возвращает одно из следующего:

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

Примеры

Получение прототипов правил обнаружения с узла сети

Получите все прототипы правил обнаружения для указанного ID узла сети.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "discoveryruleprototype.get",
    "params": {
        "hostids": "10084"
    },
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "itemid": "47253",
            "type": "23",
            "snmp_oid": "",
            "hostid": "10084",
            "name": "Обнаружение табличных пространств для {#DB}",
            "key_": "db.tablespace.discovery[{#DB}]",
            "delay": "0",
            "history": "31d",
            "trends": "365d",
            "status": "0",
            "value_type": "4",
            "trapper_hosts": "",
            "units": "",
            "logtimefmt": "",
            "templateid": "0",
            "valuemapid": "0",
            "params": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "flags": "3",
            "interfaceid": "0",
            "description": "",
            "inventory_link": "0",
            "lifetime": "7d",
            "jmx_endpoint": "",
            "master_itemid": "0",
            "timeout": "",
            "url": "",
            "query_fields": [],
            "posts": "",
            "status_codes": "200",
            "follow_redirects": "1",
            "post_type": "0",
            "http_proxy": "",
            "headers": [],
            "retrieve_mode": "0",
            "request_method": "0",
            "output_format": "0",
            "ssl_cert_file": "",
            "ssl_key_file": "",
            "ssl_key_password": "",
            "verify_peer": "0",
            "verify_host": "0",
            "allow_traps": "0",
            "discover": "0",
            "uuid": "",
            "lifetime_type": "0",
            "enabled_lifetime_type": "2",
            "enabled_lifetime": "0",
            "parameters": []
        }
    ],
    "id": 1
}

См. также

Исходный код

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