Получение состояния работоспособности системы

Kaspersky Research Sandbox предоставляет API, позволяющий определить, может ли объект быть успешно выполнен. Например, приложение может работать нестабильно из-за того, что не работает одна из служб или на диске недостаточно свободного места.

Запрос

Метод запроса: GET

Конечная точка: https://<server name>/api/v1/sandbox/health

Параметры

Эта конечная точка не требует параметров запроса.

Пример команды cURL:

$ curl --user <user name> --request GET 'https://<server name>/api/v1/sandbox/health'

Вам будет предложено ввести пароль. Пароль не отображается во время ввода.

Ответы

Конечная точка возвращает индикатор состояния работоспособности Kaspersky Research Sandbox.

200 OK

Состояние работоспособности получено успешно.

Параметры ответа 200 OK

Параметр

Тип данных

Описание

healthy

логический

Указывает, могут ли объекты быть успешно выполнены в Kaspersky Research Sandbox.

Доступные значения:

  • true – Kaspersky Research Sandbox работает стабильно, можно запускать задачи выполнения объектов.
  • false – Kaspersky Research Sandbox работает нестабильно, невозможно корректно обработать задачи выполнения.

detailed

массив

Массив, содержащий поля, описанные в таблице ниже.

sb_is_dead

логический

Указывает, является ли среда выполнения допустимой.

Доступные значения:

  • true – среда выполнения нестабильна, вы не можете запускать задачи выполнения объектов.
  • false – среда выполнения стабильна, можно запускать задачи выполнения объектов.

av_components_are_expired

логический

Указывает, обновлены ли антивирусные базы.

Доступные значения:

  • true – антивирусные базы не обновлены, невозможно корректно обработать задачи выполнения. Обновите базы данных перед запуском задач.
  • false – антивирусные базы обновлены, можно запускать задачи выполнения объектов.

kpsn_is_dead

логический

Указывает, подключено ли приложение Kaspersky Research Sandbox к KPSN.

Доступные значения:

  • true – приложение Kaspersky Research Sandbox не подключено к KPSN, невозможно корректно обработать задачи выполнения.
  • false – приложение Kaspersky Research Sandbox подключено к KPSN, можно запускать задачи выполнения объектов.

scanner_detects_is_dead

логический

Указывает, доступна ли служба сканирования обнаружения (scanner_detects).

Доступные значения:

  • true – служба scanner_detects неактивна, невозможно корректно обработать задачи выполнения.
  • false – служба scanner_detects активна, можно запускать задачи выполнения объектов.

scanner_types_is_dead

логический

Указывает, доступна ли служба сканера типов файлов (scanner_types).

Доступные значения:

  • true – служба scanner_types неактивна, невозможно корректно обработать задачи выполнения.
  • false – служба scanner_types активна, можно запускать задачи выполнения объектов.

scanner_klmr_is_dead

логический

Указывает, доступна ли служба сканера klmr (scanner_klmr).

Доступные значения:

  • true – служба scanner_klmr неактивна, невозможно корректно обработать задачи выполнения.
  • false – служба scanner_klmr активна, можно запускать задачи выполнения объектов.

ksn_kpsn_disabled

логический

Указывает, включен ли сервис KSN или KPSN.

Доступные значения:

  • true – KSN и KPSN отключены.
  • false – KSN или KSPN включен.

ksn_is_dead

логический

Указывает, подключено ли приложение Kaspersky Research Sandbox к KSN.

Доступные значения:

  • true – приложение Kaspersky Research Sandbox не подключено к KSN. Значение также будет равно true, если сервис KSN отключен.
  • false – приложение Kaspersky Research Sandbox подключено к KSN.

no_windows_exec_environments

логический

Указывает, установлена ли среда Microsoft Windows.

Доступные значения:

  • true – среда выполнения Microsoft Windows не установлена, невозможно корректно обработать задачи выполнения.
  • false – среда выполнения Microsoft Windows установлена, задачи выполнения могут обрабатываться корректно.

insufficient_disk_space

логический

Показывает, достаточно ли свободного места на сервере.

Доступные значения:

  • true – доступно менее 10% свободного места, невозможно корректно обработать задачи выполнения. Освободите место на жестком диске сервера перед запуском задач.
  • false – свободного места достаточно, можно запускать задачи выполнения объектов.

path_state

логический

Устаревший параметр, будет удален в будущих версиях.

Показывает, достаточно ли свободного места на сервере.

Доступные значения:

  • true – свободного места достаточно, можно запускать задачи выполнения объектов.
  • false – доступно менее 10% свободного места, невозможно корректно обработать задачи выполнения. Освободите место на жестком диске сервера перед запуском задач.

400 Bad Request

Не удалось получить состояние работоспособности Kaspersky Research Sandbox.

401 Unauthorized

Не удалось получить состояние работоспособности Kaspersky Research Sandbox из-за неверных учетных данных пользователя.

500 Internal Server Error

Не удалось получить состояние работоспособности Kaspersky Research Sandbox из-за внутренней ошибки сервера.

В начало