На странице
dcheck.get
Описание
integer/array dcheck.get(объект parameters)
Метод позволяет получить проверки обнаружения по заданным параметрам.
Этот метод доступен пользователям любого типа. Разрешения на вызов метода можно отозвать в настройках ролей пользователя. Дополнительную информацию см. в разделе Роли пользователей.
Параметры
(object) Параметры, определяющие желаемый вывод.
Метод поддерживает следующие параметры.
| Параметр | Тип | Описание |
|---|---|---|
| dcheckids | ID/array | Возвращать только проверки обнаружения с указанными ID. |
| druleids | ID/array | Возвращать только проверки обнаружения, принадлежащие указанным правилам обнаружения. |
| dserviceids | ID/array | Возвращать только проверки обнаружения, которые обнаружили указанные обнаруженные сервисы. |
| selectDRules | query | Возвращать правила обнаружения, связанные с проверками обнаружения. |
| sortfield | string/array | Сортировать результат по указанным свойствам. Возможные значения: dcheckid, druleid. |
| countOutput | boolean | Эти параметры описаны в справочном комментарии. |
| 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"
},
"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",
"snmpv3_contextname": "",
"host_source": "1",
"name_source": "0",
"allow_redirect": "0"
}
],
"id": 1
}
Источник
CDCheck::get() в ui/include/classes/api/services/CDCheck.php.