Просмотр кода страницы Обнаружение аномалий приложения 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/applications</nowiki></code>
|-
|Среда ActiveGate
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/applications</nowiki></code>
|}

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

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

== Ответ ==

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

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

==== Объект <code>ApplicationAnomalyDetectionConfig</code> ====
Настройка обнаружения аномалий для приложений.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|metadata
|ConfigurationMetadata
|Метаданные, полезные для отладки
|-
|responseTimeDegradation
|ResponseTimeDegradationDetectionConfig
|Настройка обнаружения ухудшения времени отклика.
|-
|trafficDrop
|TrafficDropDetectionConfig
|Настройка обнаружения падения трафика.
|-
|trafficSpike
|TrafficSpikeDetectionConfig
|Настройка обнаружения всплесков трафика.
|-
|failureRateIncrease
|FailureRateIncreaseDetectionConfig
|Конфигурация обнаружения увеличения частоты отказов.
|}

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

==== Объект <code>ResponseTimeDegradationDetectionConfig</code> ====
Настройка обнаружения ухудшения времени отклика.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|detectionMode
|string
|Как обнаружить ухудшение времени отклика: автоматически, или на основе фиксированных порогов, или не обнаруживать.

Элемент может содержать эти значения

* <code>DETECT_AUTOMATICALLY</code>
* <code>DETECT_USING_FIXED_THRESHOLDS</code>
* <code>DONT_DETECT</code>
|-
|automaticDetection
|ResponseTimeDegradationAutodetectionConfig
|Параметры автоматического определения деградации времени отклика. Требуется, если для параметра discoveryMode установлено значение <code>DETECT_AUTOMATICALLY</code>. В противном случае неприменимо.

Нарушение любого критерия вызывает предупреждение.
|-
|thresholds
|ResponseTimeDegradationThresholdConfig
|Фиксированные пороги для обнаружения ухудшения времени отклика.

Требуется, если режим обнаружения равен <code>DETECT_USING_FIXED_THRESHOLDS</code>. В противном случае неприменимо.
|}

==== Объект <code>ResponseTimeDegradationAutodetectionConfig</code> ====
Параметры автоматического определения деградации времени отклика. Требуется, если для параметра discoveryMode установлено значение <code>DETECT_AUTOMATICALLY</code>. В противном случае неприменимо.

Нарушение любого критерия вызывает предупреждение.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|responseTimeDegradationMilliseconds
|integer
|Предупреждать, если время отклика ухудшится за ''X'' миллисекунд.
|-
|responseTimeDegradationPercent
|integer
|Предупреждать, если время отклика превышает ''X'' %.
|-
|slowestResponseTimeDegradationMilliseconds
|integer
|Предупреждать, если время отклика самых медленных 10% ухудшится за ''X'' миллисекунд.
|-
|slowestResponseTimeDegradationPercent
|integer
|Предупреждать, если время отклика самых медленных 10% ухудшится за ''X'' %.
|-
|loadThreshold
|string
|Минимальная нагрузка на сервис для обнаружения ухудшения времени отклика.

Ухудшение времени отклика служб с меньшей нагрузкой не приведет к срабатыванию предупреждений.

Элемент может содержать эти значения

* <code>FIFTEEN_REQUESTS_PER_MINUTE</code>
* <code>FIVE_REQUESTS_PER_MINUTE</code>
* <code>ONE_REQUEST_PER_MINUTE</code>
* <code>TEN_REQUESTS_PER_MINUTE</code>
|}

==== Объект <code>ResponseTimeDegradationThresholdConfig</code> ====
Фиксированные пороги для обнаружения ухудшения времени отклика.

Требуется, если режим обнаружения равен <code>DETECT_USING_FIXED_THRESHOLDS</code>. В противном случае неприменимо.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|responseTimeThresholdMilliseconds
|integer
|Время отклика в течение любого 5-минутного периода для срабатывания оповещения в миллисекундах.
|-
|slowestResponseTimeThresholdMilliseconds
|integer
|Время отклика 10 % самых медленных в течение любого 5-минутного периода времени для срабатывания оповещения, в миллисекундах.
|-
|loadThreshold
|string
|Минимальная нагрузка на сервис для обнаружения ухудшения времени отклика.

Ухудшение времени отклика служб с меньшей нагрузкой не приведет к срабатыванию предупреждений.

Элемент может содержать эти значения

* <code>FIFTEEN_REQUESTS_PER_MINUTE</code>
* <code>FIVE_REQUESTS_PER_MINUTE</code>
* <code>ONE_REQUEST_PER_MINUTE</code>
* <code>TEN_REQUESTS_PER_MINUTE</code>
|-
|sensitivity
|string
|Чувствительность порога.

При <code>low</code>чувствительности используется высокая статистическая достоверность. Кратковременные нарушения (например, из-за резкого скачка нагрузки) не вызывают оповещения.

В <code>high</code>случае чувствительности статистическая достоверность не используется. Каждое нарушение вызывает оповещение.

Элемент может содержать эти значения

* <code>HIGH</code>
* <code>LOW</code>
* <code>MEDIUM</code>
|}

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

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

==== Объект <code>FailureRateIncreaseDetectionConfig</code> ====
Конфигурация обнаружения увеличения частоты отказов.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|detectionMode
|string
|Как обнаружить увеличение частоты отказов: автоматически, или на основе фиксированных порогов, или не обнаруживать.

Элемент может содержать эти значения

* <code>DETECT_AUTOMATICALLY</code>
* <code>DETECT_USING_FIXED_THRESHOLDS</code>
* <code>DONT_DETECT</code>
|-
|automaticDetection
|FailureRateIncreaseAutodetectionConfig
|Параметры автообнаружения увеличивают частоту отказов. Требуется, если режим обнаружения равен <code>DETECT_AUTOMATICALLY</code>. В противном случае неприменимо.

Абсолютный и относительный пороги должны быть превышены, чтобы сработало оповещение.

Пример: если ожидаемая частота ошибок составляет 1,5 %, и вы установили абсолютное увеличение на 1 % и относительное увеличение на 50 %, пороговые значения будут следующими: Абсолютный: 1,5 % + 1 % = 2,5 % Относительный: 1,5 % + 1,5 % * 50% = 2,25%
|-
|thresholds
|FailureRateIncreaseThresholdConfig
|Фиксированные пороги для обнаружения увеличения частоты отказов.

Требуется, если режим обнаружения равен <code>DETECT_USING_FIXED_THRESHOLDS</code>. В противном случае неприменимо.
|}

==== Объект <code>FailureRateIncreaseAutodetectionConfig</code> ====
Параметры автообнаружения увеличивают частоту отказов. Требуется, если режим обнаружения равен <code>DETECT_AUTOMATICALLY</code>. В противном случае неприменимо.

Абсолютный и относительный пороги должны быть превышены, чтобы сработало оповещение.

Пример: если ожидаемая частота ошибок составляет 1,5 %, и вы установили абсолютное увеличение на 1 % и относительное увеличение на 50 %, пороговые значения будут следующими: Абсолютный: 1,5 % + 1 % = 2,5 % Относительный: 1,5 % + 1,5 % * 50% = 2,25%
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|failingServiceCallPercentageIncreaseAbsolute
|integer
|Абсолютный прирост числа неудачных вызовов службы для срабатывания оповещения, %.
|-
|failingServiceCallPercentageIncreaseRelative
|integer
|Относительное увеличение числа неудачных вызовов службы для срабатывания оповещения, %.
|}

==== Объект <code>FailureRateIncreaseThresholdConfig</code> ====
Фиксированные пороги для обнаружения увеличения частоты отказов.

Требуется, если режим обнаружения равен <code>DETECT_USING_FIXED_THRESHOLDS</code>. В противном случае неприменимо.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|threshold
|integer
|Частота отказов в течение любого 5-минутного периода для срабатывания оповещения, %.
|-
|sensitivity
|string
|Чувствительность порога.

При <code>low</code>чувствительности используется высокая статистическая достоверность. Кратковременные нарушения (например, из-за резкого скачка нагрузки) не вызывают оповещения.

В <code>high</code>случае чувствительности статистическая достоверность не используется. Каждое нарушение вызывает оповещение.

Элемент может содержать эти значения

* <code>HIGH</code>
* <code>LOW</code>
* <code>MEDIUM</code>
|}

=== JSON-модель тела ответа ===
 <code>{
   "responseTimeDegradation": {
     "detectionMode": "DETECT_AUTOMATICALLY",
     "automaticDetection": {
       "responseTimeDegradationMilliseconds": 250,
       "responseTimeDegradationPercent": 90,
       "slowestResponseTimeDegradationMilliseconds": 500,
       "slowestResponseTimeDegradationPercent": 200,
       "loadThreshold": "ONE_REQUEST_PER_MINUTE"
     }
   },
   "trafficDrop": {
     "enabled": true,
     "trafficDropPercent": 95
   },
   "trafficSpike": {
     "enabled": false
   },
   "failureRateIncrease": {
     "detectionMode": "DETECT_USING_FIXED_THRESHOLDS",
     "thresholds": {
       "threshold": 10,
       "sensitivity": "LOW"
     }
   }
 }</code>

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

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

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

[[Файл:app1.png]]

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

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

==== Тело ответа ====
 <code>{
   "metadata": {
     "clusterVersion": "1.163.0.20190130-210004",
     "configurationVersions": [
       2
     ]
   },
   "responseTimeDegradation": {
     "detectionMode": "DETECT_AUTOMATICALLY",
     "automaticDetection": {
       "responseTimeDegradationMilliseconds": 100,
       "responseTimeDegradationPercent": 50,
       "slowestResponseTimeDegradationMilliseconds": 1000,
       "slowestResponseTimeDegradationPercent": 10,
       "loadThreshold": "TEN_REQUESTS_PER_MINUTE"
     }
   },
   "trafficDrop": {
     "enabled": true,
     "trafficDropPercent": 50
   },
   "trafficSpike": {
     "enabled": false
   },
   "failureRateIncrease": {
     "detectionMode": "DETECT_AUTOMATICALLY",
     "automaticDetection": {
       "failingServiceCallPercentageIncreaseAbsolute": 5,
       "failingServiceCallPercentageIncreaseRelative": 50
     }
   }
 }</code>

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