Documentation

Sidebar

Zabbix Summit 2022
Register for Zabbix Summit 2022

dcheck.get

целое число/массив dcheck.get(объект параметры)

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

Параметры

(объект) Параметры задают желаемый вывод.

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

Параметр Тип Описание
dcheckids строка/массив Возврат проверок обнаружения только с заданными ID.
druleids строка/массив Возврат только тех проверок обнаружения, которые принадлежат заданным правилам обнаружения.
dserviceids строка/массив Возврат только тех проверок обнаружения, которые нашли заданные обнаруженные сервисы.
sortfield строка/массив Сортировка результата в соответствии с заданными свойствами.

Возможные значения: dcheckid и druleid.
countOutput флаг Эти параметры являются общими для всех методов get и они описаны в справочных комментариях.
editable логический
excludeSearch флаг
filter объект
limit целое число
output запрос
preservekeys флаг
search объект
searchByAny логический
searchWildcardsEnabled логический
sortorder строка/массив
startSearch флаг

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

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

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

Примеры

Получение проверок обнаружения одного правила обнаружения

Получение всех проверок обнаружения, которые используются правилом обнаружения "6".

Запрос:

{
           "jsonrpc": "2.0",
           "method": "dcheck.get",
           "params": {
               "output": "extend",
               "dcheckids": "6"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Ответ:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "dcheckid": "6",
                   "druleid": "4",
                   "type": "3",
                   "key_": "",
                   "snmp_community": "",
                   "ports": "21",
                   "snmpv3_securityname": "",
                   "snmpv3_securitylevel": "0",
                   "snmpv3_authpassphrase": "",
                   "snmpv3_privpassphrase": "",
                   "uniq": "0",
                   "snmpv3_authprotocol": "0",
                   "snmpv3_privprotocol": "0"
               }
           ],
           "id": 1
       }

Исходный код

CDCheck::get() в frontends/php/include/classes/api/services/CDCheck.php.