Обнаружение аномалий хоста API - PUT конфигурация

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

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

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

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

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

Параметры

Параметр	Тип	Описание	In	Необходимость
body	HostsAnomalyDetectionConfig	Тело JSON запроса. Содержит параметры конфигурации обнаружения аномалий хоста.	body	по желанию

Объекты тела запроса

Объект 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	Время ГХ превышает 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
    }
  }
}

Ответ

Коды ответов

Код	Тип	Описание
204		Успех. Конфигурация обновлена. Ответ не имеет тела.
400	ErrorEnvelope	Не удалось. Ввод недействителен

Проверка полезную нагрузку

Мы рекомендуем вам проверить полезную нагрузку перед ее отправкой с фактическим запросом. Код ответа 204 указывает на действительную полезную нагрузку.

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

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

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

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

Ответ

Коды ответов

Код	Тип	Описание
204		Подтверждено. Представленная конфигурация действительна. Ответ не имеет тела.
400	ErrorEnvelope	Не удалось. Ввод недействителен

Пример

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

• Предупреждает, если загрузка ЦП превышает 90 % в 3 из 5 образцов.

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

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

Curl

curl -X PUT \
  https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/hosts \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
  -H 'Content-Type: application/json' \
  -d '{<truncated - see the Request body section below>}'

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

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

Тело запроса

{
  "connectionLostDetection": {
    "enabled": true,
    "enabledOnGracefulShutdowns": true
  },
  "highCpuSaturationDetection": {
    "enabled": true,
    "customThresholds": {
      "cpuSaturation": 90
    }
  },
  "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
  }
}

Код ответа

204

Результат

Обновленная конфигурация имеет следующие параметры: