Обнаружение аномалий хоста API - GET конфигурация: различия между версиями

Текущая версия на 14:53, 28 октября 2022

Получает конфигурацию обнаружения аномалий для хостов.

Запрос создает в качестве полезной нагрузки application/json формат.

GET	Managed	`https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/hosts`
GET	Среда АктивногоШлюза	`https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/hosts`

Аутентификация

Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение конфигурации ( ReadConfig) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Запрос не предоставляет никаких настраиваемых параметров.

Ответ

Коды ответов

Код	Тип	Описание
200	HostsAnomalyDetectionConfig	Успех

Объекты тела ответа

Объект `HostsAnomalyDetectionConfig`

Настройка обнаружения аномалий для хостов.

Элемент	Тип	Описание
metadata	ConfigurationMetadata	Метаданные, полезные для отладки
connectionLostDetection	ConnectionLostDetectionConfig	Настройка обнаружения потерянного соединения.
highCpuSaturationDetection	HighCpuSaturationDetectionConfig	Конфигурация обнаружения высокой загрузки ЦП
highMemoryDetection	HighMemoryDetectionConfig	Конфигурация обнаружения высокого использования памяти.
highGcActivityDetection	HighGcActivityDetectionConfig	Настройка обнаружения высокой активности сборщика мусора.
outOfMemoryDetection	OutOfMemoryDetectionConfig	Конфигурация Java для обнаружения проблем с нехваткой памяти.
outOfThreadsDetection	OutOfThreadsDetectionConfig	Конфигурация обнаружения проблем Java вне потоков.
networkDroppedPacketsDetection	NetworkDroppedPacketsDetectionConfig	Настройка обнаружения большого количества отброшенных пакетов.
networkErrorsDetection	NetworkErrorsDetectionConfig	Настройка обнаружения большого количества сетевых ошибок.
highNetworkDetection	HighNetworkDetectionConfig	Конфигурация обнаружения высокой загрузки сети.
networkTcpProblemsDetection	NetworkTcpProblemsDetectionConfig	Настройка обнаружения проблем с подключением TCP.
networkHighRetransmissionDetection	NetworkHighRetransmissionDetectionConfig	Конфигурация обнаружения высокой скорости повторной передачи.
diskLowSpaceDetection	DiskLowSpaceDetectionConfig	Настройка обнаружения нехватки места на диске.
diskSlowWritesAndReadsDetection	DiskSlowWritesAndReadsDetectionConfig	Настройка обнаружения медленно работающих дисков.
diskLowInodesDetection	DiskLowInodesDetectionConfig	Конфигурация обнаружения низкого количества инодов на диске.

Объект `ConfigurationMetadata`

Метаданные, полезные для отладки

Элемент	Тип	Описание
configurationVersions	integer[]	Отсортированный список номеров версий конфигурации.
currentConfigurationVersions	string[]	Отсортированный список номеров версий конфигурации.
clusterVersion	string	Версия Ключ-АСТРОМ.

Объект `ConnectionLostDetectionConfig`

Настройка обнаружения потерянного соединения.

Элемент	Тип	Описание
enabled	boolean	Обнаружение включено ( `true`) или отключено ( `false`).
EnabledOnGracefulShutdowns	boolean	Оповещение ( `true`) о корректном завершении работы хоста.

Объект `HighCpuSaturationDetectionConfig`

Конфигурация обнаружения высокой загрузки ЦП

Элемент	Тип	Описание
enabled	boolean	Обнаружение включено ( `true`) или отключено ( `false`).
customThresholds	HighCpuSaturationThresholds	Пользовательские пороги для высокой загрузки ЦП. Если не установлено, то используется автоматический режим.

Объект `HighCpuSaturationThresholds`

Пользовательские пороги для высокой загрузки ЦП. Если не установлено, то используется автоматический режим.

Элемент	Тип	Описание
cpuSaturation	integer	Предупреждает, если загрузка ЦП превышает X % в 3 из 5 выборок.

Объект `HighMemoryDetectionConfig`

Конфигурация обнаружения высокого использования памяти.

Элемент	Тип	Описание
enabled	boolean	Обнаружение включено ( `true`) или отключено ( `false`).
customThresholds	HighMemoryThresholds	Пользовательские пороги для высокого использования памяти. Если не установлено, то используется автоматический режим. Оба условия должны быть выполнены для срабатывания предупреждения.

Объект `HighMemoryThresholds`

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

Оба условия должны быть выполнены для срабатывания предупреждения.

Элемент	Тип	Описание
pageFaultsPerSecondWindows	integer	Частота ошибок страницы памяти выше, чем X ошибок в секунду в Windows.
usedMemoryPercentageWindows	integer	Использование памяти выше, чем X % в Windows.
pageFaultsPerSecondNonWindows	integer	Частота ошибок страницы памяти выше, чем X ошибок в секунду в Linux.
usedMemoryPercentageNonWindows	integer	Использование памяти выше, чем X % в Linux.

Объект `HighGcActivityDetectionConfig`

Настройка обнаружения высокой активности сборщика мусора.

Элемент	Тип	Описание
enabled	boolean	Обнаружение включено ( `true`) или отключено ( `false`).
customThresholds	HighGcActivityThresholds	Пользовательские пороги для высокой активности GC. Если не установлено, используется автоматический режим. Выполнение любого из этих условий приводит к срабатыванию предупреждения.

Объект `HighGcActivityThresholds`

Пользовательские пороги для высокой активности GC. Если не установлено, используется автоматический режим.

Выполнение любого из этих условий приводит к срабатыванию предупреждения.

Элемент	Тип	Описание
gcTimePercentage	integer	Время GC превышает X % в 3 из 5 образцов.
gcSuspensionPercentage	integer	Взвесь GC выше, чем X % в 3 из 5 образцов.

Объект `OutOfMemoryDetectionConfig`

Конфигурация Java для обнаружения проблем с нехваткой памяти.

Элемент	Тип	Описание
enabled	boolean	Обнаружение включено ( `true`) или отключено ( `false`).
customThresholds	OutOfMemoryThresholds	Пользовательские пороги для Java из памяти. Если не установлено, используется автоматический режим.

Объект `OutOfMemoryThresholds`

Пользовательские пороги для Java из памяти. Если не установлено, используется автоматический режим.

Элемент	Тип	Описание
outOfMemoryExceptionsNumber	integer	Предупреждать, если количество исключений Java из-за нехватки памяти составляет X в минуту или выше.

Объект `OutOfThreadsDetectionConfig`

Конфигурация обнаружения проблем Java вне потоков.

Элемент	Тип	Описание
enabled	boolean	Обнаружение включено ( `true`) или отключено ( `false`).
customThresholds	OutOfThreadsThresholds	Пользовательские пороги для обнаружения Java вне потоков. Если не установлено, используется автоматический режим.

Объект `OutOfThreadsThresholds`

Пользовательские пороги для обнаружения Java вне потоков. Если не установлено, используется автоматический режим.

Элемент	Тип	Описание
outOfThreadsExceptionsNumber	integer	Предупреждать, если количество исключений Java out of threads равно X в минуту или выше.

Объект `NetworkDroppedPacketsDetectionConfig`

Настройка обнаружения большого количества отброшенных пакетов.

Элемент	Тип	Описание
enabled	boolean	Обнаружение включено ( `true`) или отключено ( `false`).
customThresholds	NetworkDroppedPacketsThresholds	Пользовательские пороги для отброшенных пакетов. Если не установлено, используется автоматический режим. Все эти условия должны быть соблюдены для срабатывания оповещения.

Объект `NetworkDroppedPacketsThresholds`

Пользовательские пороги для отброшенных пакетов. Если не установлено, используется автоматический режим.

Все эти условия должны быть соблюдены для срабатывания оповещения.

Элемент	Тип	Описание
dropPacketsPercentage	integer	Процент потерянных пакетов при приеме/передаче превышает X % в 3 из 5 образцов.
TotalPacketsRate	integer	Суммарная скорость приема/передачи пакетов превышает X пакетов в секунду в 3 из 5 выборок.

Объект `NetworkErrorsDetectionConfig`

Настройка обнаружения большого количества сетевых ошибок.

Элемент	Тип	Описание
enabled	boolean	Обнаружение включено ( `true`) или отключено ( `false`).
customThresholds	NetworkErrorsThresholds	Пользовательские пороги для сетевых ошибок. Если не установлено, используется автоматический режим. Все эти условия должны быть соблюдены для срабатывания оповещения.

Объект `NetworkErrorsThresholds`

Пользовательские пороги для сетевых ошибок. Если не установлено, используется автоматический режим.

Все эти условия должны быть соблюдены для срабатывания оповещения.

Элемент	Тип	Описание
errorsPercentage	integer	Процент пакетов с ошибками приема/передачи превышает X % в 3 из 5 выборок.
TotalPacketsRate	integer	Суммарная скорость приема/передачи пакетов превышает X пакетов в секунду в 3 из 5 выборок.

Объект `HighNetworkDetectionConfig`

Конфигурация обнаружения высокой загрузки сети.

Элемент	Тип	Описание
enabled	boolean	Обнаружение включено ( `true`) или отключено ( `false`).
customThresholds	HighNetworkThresholds	Пользовательские пороги для высокой загрузки сети. Если не установлено, используется автоматический режим.

Объект `HighNetworkThresholds`

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

Элемент	Тип	Описание
utilizationPercentage	integer	Оповещение, если использование отправленного/полученного трафика превышает X % в 3 из 5 выборок.

Объект `NetworkTcpProblemsDetectionConfig`

Настройка обнаружения проблем с подключением TCP.

Элемент	Тип	Описание
enabled	boolean	Обнаружение включено ( `true`) или отключено ( `false`).
customThresholds	NetworkTcpProblemsThresholds	Пользовательские пороги для проблем с TCP-соединением. Если не установлено, используется автоматический режим. Все эти условия должны быть соблюдены для срабатывания оповещения.

Объект `NetworkTcpProblemsThresholds`

Пользовательские пороги для проблем с TCP-соединением. Если не установлено, используется автоматический режим.

Все эти условия должны быть соблюдены для срабатывания оповещения.

Элемент	Тип	Описание
newConnectionFailuresPercentage	integer	Процент новых сбоев соединения превышает X % в 3 из 5 выборок.
failedConnectionsNumberPerMinute	integer	Количество неудачных подключений превышает X подключений в минуту в 3 из 5 образцов.

Объект _ `NetworkHighRetransmissionDetectionConfig`

Конфигурация обнаружения высокой скорости повторной передачи.

Элемент	Тип	Описание
enabled	boolean	Обнаружение включено ( `true`) или отключено ( `false`).
customThresholds	NetworkHighRetransmissionThresholds	Пользовательские пороги для высокой скорости повторной передачи. Если не установлено, используется автоматический режим. Все эти условия должны быть соблюдены для срабатывания оповещения.

Объект `NetworkHighRetransmissionThresholds`

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

Все эти условия должны быть соблюдены для срабатывания оповещения.

Элемент	Тип	Описание
retransmissionRatePercentage	integer	Скорость повторной передачи выше, чем X % в 3 из 5 образцов.
retransmittedPacketsNumberPerMinute	integer	Количество повторно переданных пакетов превышает X пакетов в минуту в 3 из 5 выборок.

Объект `DiskLowSpaceDetectionConfig`

Настройка обнаружения нехватки места на диске.

Элемент	Тип	Описание
enabled	boolean	Обнаружение включено ( `true`) или отключено ( `false`).
customThresholds	DiskLowSpaceThresholds	Пользовательские пороги для нехватки места на диске. Если не установлено, используется автоматический режим.

Объект `DiskLowSpaceThresholds`

Пользовательские пороги для нехватки места на диске. Если не установлено, используется автоматический режим.

Элемент	Тип	Описание
freeSpacePercentage	integer	Предупреждает, если свободное место на диске меньше X % в 3 из 5 образцов.

Объект `DiskSlowWritesAndReadsDetectionConfig`

Настройка обнаружения медленно работающих дисков.

Элемент	Тип	Описание
enabled	boolean	Обнаружение включено ( `true`) или отключено ( `false`).
customThresholds	DiskSlowWriteAndReadsThresholds	Пользовательские пороги для медленных дисков. Если не установлено, используется автоматический режим.

Объект `DiskSlowWriteAndReadsThresholds`

Пользовательские пороги для медленных дисков. Если не установлено, используется автоматический режим.

Элемент	Тип	Описание
writeAndReadTime	integer	Предупреждает, если время чтения/записи диска превышает X миллисекунд в 3 из 5 выборок.

Объект `DiskLowInodesDetectionConfig`

Конфигурация обнаружения низкого количества инодов на диске.

Элемент	Тип	Описание
enabled	boolean	Обнаружение включено ( `true`) или отключено ( `false`).
customThresholds	DiskLowInodesThresholds	Пользовательские пороги для низкого количества инодов на диске. Если не установлено, используется автоматический режим.

Объект `DiskLowInodesThresholds`

Пользовательские пороги для низкого количества инодов на диске. Если не установлено, используется автоматический режим.

Элемент	Тип	Описание
freeInodesPercentage	integer	Оповещает, если процент доступных инодов ниже X % в 3 из 5 выборок.

JSON-модель тела ответа

{
  "metadata": {
    "configurationVersions": [
      4,
      2
    ],
    "clusterVersion": "Mock version"
  },
  "connectionLostDetection": {
    "enabled": true,
    "enabledOnGracefulShutdowns": true
  },
  "highCpuSaturationDetection": {
    "enabled": true,
    "customThresholds": {
      "cpuSaturation": 90
    }
  },
  "highMemoryDetection": {
    "enabled": true,
    "customThresholds": {
      "pageFaultsPerSecondWindows": 50,
      "usedMemoryPercentageWindows": 85,
      "pageFaultsPerSecondNonWindows": 10,
      "usedMemoryPercentageNonWindows": 85
    }
  },
  "highGcActivityDetection": {
    "enabled": true,
    "customThresholds": {
      "gcTimePercentage": 35,
      "gcSuspensionPercentage": 20
    }
  },
  "outOfMemoryDetection": {
    "enabled": true,
    "customThresholds": {
      "outOfMemoryExceptionsNumber": 2
    }
  },
  "outOfThreadsDetection": {
    "enabled": true,
    "customThresholds": {
      "outOfThreadsExceptionsNumber": 2
    }
  },
  "networkDroppedPacketsDetection": {
    "enabled": true,
    "customThresholds": {
      "droppedPacketsPercentage": 8,
      "totalPacketsRate": 8
    }
  },
  "networkErrorsDetection": {
    "enabled": true,
    "customThresholds": {
      "errorsPercentage": 9,
      "totalPacketsRate": 9
    }
  },
  "highNetworkDetection": {
    "enabled": true,
    "customThresholds": {
      "utilizationPercentage": 88
    }
  },
  "networkTcpProblemsDetection": {
    "enabled": true,
    "customThresholds": {
      "newConnectionFailuresPercentage": 5,
      "failedConnectionsNumberPerMinute": 5
    }
  },
  "networkHighRetransmissionDetection": {
    "enabled": true,
    "customThresholds": {
      "retransmissionRatePercentage": 15,
      "retransmittedPacketsNumberPerMinute": 15
    }
  },
  "diskLowSpaceDetection": {
    "enabled": true,
    "customThresholds": {
      "freeSpacePercentage": 10
    }
  },
  "diskSlowWritesAndReadsDetection": {
    "enabled": true,
    "customThresholds": {
      "writeAndReadTime": 300
    }
  },
  "diskLowInodesDetection": {
    "enabled": true,
    "customThresholds": {
      "freeInodesPercentage": 10
    }
  }
}

Пример

В этом примере запрос перечисляет текущую конфигурацию обнаружения аномалий для хостов.

Маркер API передается в заголовке авторизации .

Конфигурация имеет следующие настройки:

Curl

curl -X GET \
  https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/hosts \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

URL-адрес запроса

https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/hosts

Тело ответа

{
  "metadata": {
    "clusterVersion": "1.163.5.20190201-130834",
    "configurationVersions": [
      91
    ]
  },
  "connectionLostDetection": {
    "enabled": true,
    "enabledOnGracefulShutdowns": false
  },
  "highCpuSaturationDetection": {
    "enabled": true
  },
  "highMemoryDetection": {
    "enabled": true
  },
  "highGcActivityDetection": {
    "enabled": true
  },
  "outOfMemoryDetection": {
    "enabled": true
  },
  "outOfThreadsDetection": {
    "enabled": true
  },
  "networkDroppedPacketsDetection": {
    "enabled": true
  },
  "networkErrorsDetection": {
    "enabled": true
  },
  "highNetworkDetection": {
    "enabled": true
  },
  "networkTcpProblemsDetection": {
    "enabled": true
  },
  "networkHighRetransmissionDetection": {
    "enabled": true
  },
  "diskLowSpaceDetection": {
    "enabled": true
  },
  "diskSlowWritesAndReadsDetection": {
    "enabled": true
  },
  "diskLowInodesDetection": {
    "enabled": true
  }
}

Код ответа

200

@@ Строка 663: / Строка 663: @@
 Конфигурация имеет следующие настройки:
+[[Файл:host1.png]]
 ==== Curl ====

Аноним

Поиск

Обнаружение аномалий хоста API - GET конфигурация: различия между версиями

Текущая версия на 14:53, 28 октября 2022

Аутентификация

Параметры

Ответ

Коды ответов

Объекты тела ответа

Объект HostsAnomalyDetectionConfig

Объект ConfigurationMetadata

Объект ConnectionLostDetectionConfig

Объект HighCpuSaturationDetectionConfig

Объект HighCpuSaturationThresholds

Объект HighMemoryDetectionConfig

Объект HighMemoryThresholds

Объект HighGcActivityDetectionConfig

Объект HighGcActivityThresholds

Объект OutOfMemoryDetectionConfig

Объект OutOfMemoryThresholds

Объект OutOfThreadsDetectionConfig

Объект OutOfThreadsThresholds

Объект NetworkDroppedPacketsDetectionConfig

Объект NetworkDroppedPacketsThresholds

Объект NetworkErrorsDetectionConfig

Объект NetworkErrorsThresholds

Объект HighNetworkDetectionConfig

Объект HighNetworkThresholds

Объект NetworkTcpProblemsDetectionConfig

Объект NetworkTcpProblemsThresholds

Объект _ NetworkHighRetransmissionDetectionConfig

Объект NetworkHighRetransmissionThresholds

Объект DiskLowSpaceDetectionConfig

Объект DiskLowSpaceThresholds

Объект DiskSlowWritesAndReadsDetectionConfig

Объект DiskSlowWriteAndReadsThresholds

Объект DiskLowInodesDetectionConfig

Объект DiskLowInodesThresholds

JSON-модель тела ответа

Пример

Curl

URL-адрес запроса

Тело ответа

Код ответа

Навигация

Вики-инструменты

Инструменты для страниц

Объект `HostsAnomalyDetectionConfig`

Объект `ConfigurationMetadata`

Объект `ConnectionLostDetectionConfig`

Объект `HighCpuSaturationDetectionConfig`

Объект `HighCpuSaturationThresholds`

Объект `HighMemoryDetectionConfig`

Объект `HighMemoryThresholds`

Объект `HighGcActivityDetectionConfig`

Объект `HighGcActivityThresholds`

Объект `OutOfMemoryDetectionConfig`

Объект `OutOfMemoryThresholds`

Объект `OutOfThreadsDetectionConfig`

Объект `OutOfThreadsThresholds`

Объект `NetworkDroppedPacketsDetectionConfig`

Объект `NetworkDroppedPacketsThresholds`

Объект `NetworkErrorsDetectionConfig`

Объект `NetworkErrorsThresholds`

Объект `HighNetworkDetectionConfig`

Объект `HighNetworkThresholds`

Объект `NetworkTcpProblemsDetectionConfig`

Объект `NetworkTcpProblemsThresholds`

Объект _ `NetworkHighRetransmissionDetectionConfig`

Объект `NetworkHighRetransmissionThresholds`

Объект `DiskLowSpaceDetectionConfig`

Объект `DiskLowSpaceThresholds`

Объект `DiskSlowWritesAndReadsDetectionConfig`

Объект `DiskSlowWriteAndReadsThresholds`

Объект `DiskLowInodesDetectionConfig`

Объект `DiskLowInodesThresholds`