Обнаружение аномалий приложения API - GET конфигурация: различия между версиями
ENetrebin (обсуждение | вклад) (Новая страница: «Получает конфигурацию обнаружения аномалий для приложений. Запрос создает в качестве п...») |
ENetrebin (обсуждение | вклад) |
||
(не показаны 3 промежуточные версии этого же участника) | |||
Строка 1: | Строка 1: | ||
'''''API Ключ-АСТРОМ / Эндпойнты конфигурации / Обнаружение аномалий / Приложение / GET конфигурация''''' | |||
Получает конфигурацию обнаружения аномалий для приложений. | Получает конфигурацию обнаружения аномалий для приложений. | ||
Строка 7: | Строка 9: | ||
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/applications</nowiki></code> | |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/applications</nowiki></code> | ||
|- | |- | ||
|Среда | |Среда АктивногоШлюза | ||
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/applications</nowiki></code> | |<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/applications</nowiki></code> | ||
|} | |} | ||
Строка 338: | Строка 340: | ||
Маркер API передается в заголовке авторизации . | Маркер API передается в заголовке авторизации . | ||
==== Curl ==== | ==== Curl ==== |
Текущая версия на 17:02, 31 июля 2024
API Ключ-АСТРОМ / Эндпойнты конфигурации / Обнаружение аномалий / Приложение / GET конфигурация
Получает конфигурацию обнаружения аномалий для приложений.
Запрос создает в качестве полезной нагрузки application/json
формат.
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/applications
|
Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/applications
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение конфигурации ( ReadConfig
) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
Запрос не предоставляет никаких настраиваемых параметров.
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
200 | ApplicationAnomalyDetectionConfig | Успех |
Объекты тела ответа
Объект ApplicationAnomalyDetectionConfig
Настройка обнаружения аномалий для приложений.
Элемент | Тип | Описание |
---|---|---|
metadata | ConfigurationMetadata | Метаданные, полезные для отладки |
responseTimeDegradation | ResponseTimeDegradationDetectionConfig | Настройка обнаружения ухудшения времени отклика. |
trafficDrop | TrafficDropDetectionConfig | Настройка обнаружения падения трафика. |
trafficSpike | TrafficSpikeDetectionConfig | Настройка обнаружения всплесков трафика. |
failureRateIncrease | FailureRateIncreaseDetectionConfig | Конфигурация обнаружения увеличения частоты отказов. |
Объект ConfigurationMetadata
Метаданные, полезные для отладки
Элемент | Тип | Описание |
---|---|---|
configurationVersions | integer[] | Отсортированный список номеров версий конфигурации. |
currentConfigurationVersions | string[] | Отсортированный список номеров версий конфигурации. |
clusterVersion | string | Версия Ключ-АСТРОМ. |
Объект ResponseTimeDegradationDetectionConfig
Настройка обнаружения ухудшения времени отклика.
Элемент | Тип | Описание |
---|---|---|
detectionMode | string | Как обнаружить ухудшение времени отклика: автоматически, или на основе фиксированных порогов, или не обнаруживать.
Элемент может содержать эти значения
|
automaticDetection | ResponseTimeDegradationAutodetectionConfig | Параметры автоматического определения деградации времени отклика. Требуется, если для параметра discoveryMode установлено значение DETECT_AUTOMATICALLY . В противном случае неприменимо.
Нарушение любого критерия вызывает предупреждение. |
thresholds | ResponseTimeDegradationThresholdConfig | Фиксированные пороги для обнаружения ухудшения времени отклика.
Требуется, если режим обнаружения равен |
Объект ResponseTimeDegradationAutodetectionConfig
Параметры автоматического определения деградации времени отклика. Требуется, если для параметра discoveryMode установлено значение DETECT_AUTOMATICALLY
. В противном случае неприменимо.
Нарушение любого критерия вызывает предупреждение.
Элемент | Тип | Описание |
---|---|---|
responseTimeDegradationMilliseconds | integer | Предупреждать, если время отклика ухудшится за X миллисекунд. |
responseTimeDegradationPercent | integer | Предупреждать, если время отклика превышает X %. |
slowestResponseTimeDegradationMilliseconds | integer | Предупреждать, если время отклика самых медленных 10% ухудшится за X миллисекунд. |
slowestResponseTimeDegradationPercent | integer | Предупреждать, если время отклика самых медленных 10% ухудшится за X %. |
loadThreshold | string | Минимальная нагрузка на сервис для обнаружения ухудшения времени отклика.
Ухудшение времени отклика служб с меньшей нагрузкой не приведет к срабатыванию предупреждений. Элемент может содержать эти значения
|
Объект ResponseTimeDegradationThresholdConfig
Фиксированные пороги для обнаружения ухудшения времени отклика.
Требуется, если режим обнаружения равен DETECT_USING_FIXED_THRESHOLDS
. В противном случае неприменимо.
Элемент | Тип | Описание |
---|---|---|
responseTimeThresholdMilliseconds | integer | Время отклика в течение любого 5-минутного периода для срабатывания оповещения в миллисекундах. |
slowestResponseTimeThresholdMilliseconds | integer | Время отклика 10 % самых медленных в течение любого 5-минутного периода времени для срабатывания оповещения, в миллисекундах. |
loadThreshold | string | Минимальная нагрузка на сервис для обнаружения ухудшения времени отклика.
Ухудшение времени отклика служб с меньшей нагрузкой не приведет к срабатыванию предупреждений. Элемент может содержать эти значения
|
sensitivity | string | Чувствительность порога.
При В Элемент может содержать эти значения
|
Объект TrafficDropDetectionConfig
Настройка обнаружения падения трафика.
Элемент | Тип | Описание |
---|---|---|
enabled | boolean | Обнаружение включено ( true ) или отключено ( false ).
|
trafficDropPercent | integer | Оповещение, если наблюдаемый трафик меньше X % от ожидаемого значения. |
Объект TrafficSpikeDetectionConfig
Настройка обнаружения всплесков трафика.
Элемент | Тип | Описание |
---|---|---|
enabled | boolean | Обнаружение включено ( true ) или отключено ( false ).
|
trafficSpikePercent | integer | Оповещение, если наблюдаемый трафик превышает ожидаемое значение более чем на X %. |
Объект FailureRateIncreaseDetectionConfig
Конфигурация обнаружения увеличения частоты отказов.
Элемент | Тип | Описание |
---|---|---|
detectionMode | string | Как обнаружить увеличение частоты отказов: автоматически, или на основе фиксированных порогов, или не обнаруживать.
Элемент может содержать эти значения
|
automaticDetection | FailureRateIncreaseAutodetectionConfig | Параметры автообнаружения увеличивают частоту отказов. Требуется, если режим обнаружения равен DETECT_AUTOMATICALLY . В противном случае неприменимо.
Абсолютный и относительный пороги должны быть превышены, чтобы сработало оповещение. Пример: если ожидаемая частота ошибок составляет 1,5 %, и вы установили абсолютное увеличение на 1 % и относительное увеличение на 50 %, пороговые значения будут следующими: Абсолютный: 1,5 % + 1 % = 2,5 % Относительный: 1,5 % + 1,5 % * 50% = 2,25% |
thresholds | FailureRateIncreaseThresholdConfig | Фиксированные пороги для обнаружения увеличения частоты отказов.
Требуется, если режим обнаружения равен |
Объект FailureRateIncreaseAutodetectionConfig
Параметры автообнаружения увеличивают частоту отказов. Требуется, если режим обнаружения равен DETECT_AUTOMATICALLY
. В противном случае неприменимо.
Абсолютный и относительный пороги должны быть превышены, чтобы сработало оповещение.
Пример: если ожидаемая частота ошибок составляет 1,5 %, и вы установили абсолютное увеличение на 1 % и относительное увеличение на 50 %, пороговые значения будут следующими: Абсолютный: 1,5 % + 1 % = 2,5 % Относительный: 1,5 % + 1,5 % * 50% = 2,25%
Элемент | Тип | Описание |
---|---|---|
failingServiceCallPercentageIncreaseAbsolute | integer | Абсолютный прирост числа неудачных вызовов службы для срабатывания оповещения, %. |
failingServiceCallPercentageIncreaseRelative | integer | Относительное увеличение числа неудачных вызовов службы для срабатывания оповещения, %. |
Объект FailureRateIncreaseThresholdConfig
Фиксированные пороги для обнаружения увеличения частоты отказов.
Требуется, если режим обнаружения равен DETECT_USING_FIXED_THRESHOLDS
. В противном случае неприменимо.
Элемент | Тип | Описание |
---|---|---|
threshold | integer | Частота отказов в течение любого 5-минутного периода для срабатывания оповещения, %. |
sensitivity | string | Чувствительность порога.
При В Элемент может содержать эти значения
|
JSON-модель тела ответа
{
"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"
}
}
}
Пример
В этом примере запрос перечисляет текущую конфигурацию обнаружения аномалий для приложений.
Маркер API передается в заголовке авторизации .
Curl
curl -X GET \
https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/applications \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL-адрес запроса
https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/applications
Тело ответа
{
"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
}
}
}
Код ответа
200