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

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

Запрос создает в качестве полезной нагрузки <code>application/json</code> формат.
{| class="wikitable"
| rowspan="2" |GET
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/hosts</nowiki></code>
|-
|Среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/hosts</nowiki></code>
|}

== Аутентификация ==
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение конфигурации ( <code>ReadConfig</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .

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

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|HostsAnomalyDetectionConfig
|Успех
|}

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

==== Объект <code>HostsAnomalyDetectionConfig</code> ====
Настройка обнаружения аномалий для хостов.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|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
|Конфигурация обнаружения низкого количества инодов на диске.
|}

==== Объект <code>ConfigurationMetadata</code> ====
Метаданные, полезные для отладки
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|configurationVersions
|integer[]
|Отсортированный список номеров версий конфигурации.
|-
|currentConfigurationVersions
|string[]
|Отсортированный список номеров версий конфигурации.
|-
|clusterVersion
|string
|Версия Ключ-АСТРОМ.
|}

==== Объект <code>ConnectionLostDetectionConfig</code> ====
Настройка обнаружения потерянного соединения.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|enabled
|boolean
|Обнаружение включено ( <code>true</code>) или отключено ( <code>false</code>).
|-
|EnabledOnGracefulShutdowns
|boolean
|Оповещение ( <code>true</code>) о корректном завершении работы хоста.
|}

==== Объект <code>HighCpuSaturationDetectionConfig</code> ====
Конфигурация обнаружения высокой загрузки ЦП
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|enabled
|boolean
|Обнаружение включено ( <code>true</code>) или отключено ( <code>false</code>).
|-
|customThresholds
|HighCpuSaturationThresholds
|Пользовательские пороги для высокой загрузки ЦП. Если не установлено, то используется автоматический режим.
|}

==== Объект <code>HighCpuSaturationThresholds</code> ====
Пользовательские пороги для высокой загрузки ЦП. Если не установлено, то используется автоматический режим.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|cpuSaturation
|integer
|Предупреждает, если загрузка ЦП превышает ''X'' % в 3 из 5 выборок.
|}

==== Объект <code>HighMemoryDetectionConfig</code> ====
Конфигурация обнаружения высокого использования памяти.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|enabled
|boolean
|Обнаружение включено ( <code>true</code>) или отключено ( <code>false</code>).
|-
|customThresholds
|HighMemoryThresholds
|Пользовательские пороги для высокого использования памяти. Если не установлено, то используется автоматический режим.

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

==== Объект <code>HighMemoryThresholds</code> ====
Пользовательские пороги для высокого использования памяти. Если не установлено, то используется автоматический режим.

Оба условия должны быть выполнены для срабатывания предупреждения.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|pageFaultsPerSecondWindows
|integer
|Частота ошибок страницы памяти выше, чем ''X'' ошибок в секунду в Windows.
|-
|usedMemoryPercentageWindows
|integer
|Использование памяти выше, чем ''X'' % в Windows.
|-
|pageFaultsPerSecondNonWindows
|integer
|Частота ошибок страницы памяти выше, чем ''X'' ошибок в секунду в Linux.
|-
|usedMemoryPercentageNonWindows
|integer
|Использование памяти выше, чем ''X'' % в Linux.
|}

==== Объект <code>HighGcActivityDetectionConfig</code> ====
Настройка обнаружения высокой активности сборщика мусора.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|enabled
|boolean
|Обнаружение включено ( <code>true</code>) или отключено ( <code>false</code>).
|-
|customThresholds
|HighGcActivityThresholds
|Пользовательские пороги для высокой активности GC. Если не установлено, используется автоматический режим.

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

==== Объект <code>HighGcActivityThresholds</code> ====
Пользовательские пороги для высокой активности GC. Если не установлено, используется автоматический режим.

Выполнение любого из этих условий приводит к срабатыванию предупреждения.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|gcTimePercentage
|integer
|Время GC превышает ''X'' % в 3 из 5 образцов.
|-
|gcSuspensionPercentage
|integer
|Взвесь GC выше, чем ''X'' % в 3 из 5 образцов.
|}

==== Объект <code>OutOfMemoryDetectionConfig</code> ====
Конфигурация Java для обнаружения проблем с нехваткой памяти.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|enabled
|boolean
|Обнаружение включено ( <code>true</code>) или отключено ( <code>false</code>).
|-
|customThresholds
|OutOfMemoryThresholds
|Пользовательские пороги для Java из памяти. Если не установлено, используется автоматический режим.
|}

==== Объект <code>OutOfMemoryThresholds</code> ====
Пользовательские пороги для Java из памяти. Если не установлено, используется автоматический режим.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|outOfMemoryExceptionsNumber
|integer
|Предупреждать, если количество исключений Java из-за нехватки памяти составляет ''X'' в минуту или выше.
|}

==== Объект <code>OutOfThreadsDetectionConfig</code> ====
Конфигурация обнаружения проблем Java вне потоков.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|enabled
|boolean
|Обнаружение включено ( <code>true</code>) или отключено ( <code>false</code>).
|-
|customThresholds
|OutOfThreadsThresholds
|Пользовательские пороги для обнаружения Java вне потоков. Если не установлено, используется автоматический режим.
|}

==== Объект <code>OutOfThreadsThresholds</code> ====
Пользовательские пороги для обнаружения Java вне потоков. Если не установлено, используется автоматический режим.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|outOfThreadsExceptionsNumber
|integer
|Предупреждать, если количество исключений Java out of threads равно ''X'' в минуту или выше.
|}

==== Объект <code>NetworkDroppedPacketsDetectionConfig</code> ====
Настройка обнаружения большого количества отброшенных пакетов.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|enabled
|boolean
|Обнаружение включено ( <code>true</code>) или отключено ( <code>false</code>).
|-
|customThresholds
|NetworkDroppedPacketsThresholds
|Пользовательские пороги для отброшенных пакетов. Если не установлено, используется автоматический режим.

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

==== Объект <code>NetworkDroppedPacketsThresholds</code> ====
Пользовательские пороги для отброшенных пакетов. Если не установлено, используется автоматический режим.

Все эти условия должны быть соблюдены для срабатывания оповещения.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|dropPacketsPercentage
|integer
|Процент потерянных пакетов при приеме/передаче превышает ''X'' % в 3 из 5 образцов.
|-
|TotalPacketsRate
|integer
|Суммарная скорость приема/передачи пакетов превышает ''X'' пакетов в секунду в 3 из 5 выборок.
|}

==== Объект <code>NetworkErrorsDetectionConfig</code> ====
Настройка обнаружения большого количества сетевых ошибок.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|enabled
|boolean
|Обнаружение включено ( <code>true</code>) или отключено ( <code>false</code>).
|-
|customThresholds
|NetworkErrorsThresholds
|Пользовательские пороги для сетевых ошибок. Если не установлено, используется автоматический режим.

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

==== Объект <code>NetworkErrorsThresholds</code> ====
Пользовательские пороги для сетевых ошибок. Если не установлено, используется автоматический режим.

Все эти условия должны быть соблюдены для срабатывания оповещения.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|errorsPercentage
|integer
|Процент пакетов с ошибками приема/передачи превышает ''X'' % в 3 из 5 выборок.
|-
|TotalPacketsRate
|integer
|Суммарная скорость приема/передачи пакетов превышает ''X'' пакетов в секунду в 3 из 5 выборок.
|}

==== Объект <code>HighNetworkDetectionConfig</code> ====
Конфигурация обнаружения высокой загрузки сети.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|enabled
|boolean
|Обнаружение включено ( <code>true</code>) или отключено ( <code>false</code>).
|-
|customThresholds
|HighNetworkThresholds
|Пользовательские пороги для высокой загрузки сети. Если не установлено, используется автоматический режим.
|}

==== Объект <code>HighNetworkThresholds</code> ====
Пользовательские пороги для высокой загрузки сети. Если не установлено, используется автоматический режим.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|utilizationPercentage
|integer
|Оповещение, если использование отправленного/полученного трафика превышает ''X'' % в 3 из 5 выборок.
|}

==== Объект <code>NetworkTcpProblemsDetectionConfig</code> ====
Настройка обнаружения проблем с подключением TCP.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|enabled
|boolean
|Обнаружение включено ( <code>true</code>) или отключено ( <code>false</code>).
|-
|customThresholds
|NetworkTcpProblemsThresholds
|Пользовательские пороги для проблем с TCP-соединением. Если не установлено, используется автоматический режим.

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

==== Объект <code>NetworkTcpProblemsThresholds</code> ====
Пользовательские пороги для проблем с TCP-соединением. Если не установлено, используется автоматический режим.

Все эти условия должны быть соблюдены для срабатывания оповещения.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|newConnectionFailuresPercentage
|integer
|Процент новых сбоев соединения превышает ''X'' % в 3 из 5 выборок.
|-
|failedConnectionsNumberPerMinute
|integer
|Количество неудачных подключений превышает ''X'' подключений в минуту в 3 из 5 образцов.
|}

==== Объект _ <code>NetworkHighRetransmissionDetectionConfig</code> ====
Конфигурация обнаружения высокой скорости повторной передачи.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|enabled
|boolean
|Обнаружение включено ( <code>true</code>) или отключено ( <code>false</code>).
|-
|customThresholds
|NetworkHighRetransmissionThresholds
|Пользовательские пороги для высокой скорости повторной передачи. Если не установлено, используется автоматический режим.

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

==== Объект <code>NetworkHighRetransmissionThresholds</code> ====
Пользовательские пороги для высокой скорости повторной передачи. Если не установлено, используется автоматический режим.

Все эти условия должны быть соблюдены для срабатывания оповещения.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|retransmissionRatePercentage
|integer
|Скорость повторной передачи выше, чем ''X'' % в 3 из 5 образцов.
|-
|retransmittedPacketsNumberPerMinute
|integer
|Количество повторно переданных пакетов превышает ''X'' пакетов в минуту в 3 из 5 выборок.
|}

==== Объект <code>DiskLowSpaceDetectionConfig</code> ====
Настройка обнаружения нехватки места на диске.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|enabled
|boolean
|Обнаружение включено ( <code>true</code>) или отключено ( <code>false</code>).
|-
|customThresholds
|DiskLowSpaceThresholds
|Пользовательские пороги для нехватки места на диске. Если не установлено, используется автоматический режим.
|}

==== Объект <code>DiskLowSpaceThresholds</code> ====
Пользовательские пороги для нехватки места на диске. Если не установлено, используется автоматический режим.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|freeSpacePercentage
|integer
|Предупреждает, если свободное место на диске меньше ''X'' % в 3 из 5 образцов.
|}

==== Объект <code>DiskSlowWritesAndReadsDetectionConfig</code> ====
Настройка обнаружения медленно работающих дисков.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|enabled
|boolean
|Обнаружение включено ( <code>true</code>) или отключено ( <code>false</code>).
|-
|customThresholds
|DiskSlowWriteAndReadsThresholds
|Пользовательские пороги для медленных дисков. Если не установлено, используется автоматический режим.
|}

==== Объект <code>DiskSlowWriteAndReadsThresholds</code> ====
Пользовательские пороги для медленных дисков. Если не установлено, используется автоматический режим.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|writeAndReadTime
|integer
|Предупреждает, если время чтения/записи диска превышает ''X'' миллисекунд в 3 из 5 выборок.
|}

==== Объект <code>DiskLowInodesDetectionConfig</code> ====
Конфигурация обнаружения низкого количества инодов на диске.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|enabled
|boolean
|Обнаружение включено ( <code>true</code>) или отключено ( <code>false</code>).
|-
|customThresholds
|DiskLowInodesThresholds
|Пользовательские пороги для низкого количества инодов на диске. Если не установлено, используется автоматический режим.
|}

==== Объект <code>DiskLowInodesThresholds</code> ====
Пользовательские пороги для низкого количества инодов на диске. Если не установлено, используется автоматический режим.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|freeInodesPercentage
|integer
|Оповещает, если процент доступных инодов ниже ''X'' % в 3 из 5 выборок.
|}

=== JSON-модель тела ответа ===
 <code>{
   "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
     }
   }
 }</code>

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

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

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

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

==== URL-адрес запроса ====
 <code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/hosts</nowiki></code>

==== Тело ответа ====
 <code>{
   "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
   }
 }</code>

==== Код ответа ====
200