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

dcheck.get

Описание

integer/array dcheck.get(object parameters)

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

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

Параметры

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

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

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

Возможные значения: dcheckid и druleid.
countOutput boolean Эти параметры являются общими для всех методов get и подробно описаны в справочном комментарии.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

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

(integer/array) Возвращает:

  • · массив объектов;
  • · количество извлеченных объектов, если использовался параметр 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",
        · "host_source": "1",
        · "name_source": "0" · 
        · }
        · ],
        · "id": 1
       }

Источник

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