API обнаружения аномалий групп процессов - GET конфигурация

Материал из Документация Ключ-АСТРОМ
Версия от 14:38, 2 марта 2023; ENetrebin (обсуждение | вклад) (Новая страница: «Получает конфигурацию обнаружения аномалий для указанной группы процессов. Запрос в ка...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

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

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

GET Ключ-АСТРОМ Managed для управления https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/processGroups/{id}
Среда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/processGroups/{id}

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

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

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

Параметры

Параметр Тип Описание In Необходимость
id string Идентификатор объекта Ключ-АСТРОМ требуемой группы процессов. path необходимый

Ответ

Коды ответов

Код Тип Описание
200 AnomalyDetectionPG Успех
400 ErrorEnvelope Неуспешно. Ввод недействителен.
404 ErrorEnvelope Группа процессов не существует

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

Объект AnomalyDetectionPG

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

Элемент Тип Описание
availabilityMonitoring AvailabilityMonitoringPG Настройка мониторинга доступности для группы процессов.

Объект AvailabilityMonitoringPG

Настройка мониторинга доступности для группы процессов.

Элемент Тип Описание
method string Как контролировать доступность группы процессов:
  • PROCESS_IMPACT: оповещение, если какой-либо процесс группы становится недоступным.
  • MINIMUM_THRESHOLD: оповещение, если количество активных процессов в группе падает ниже указанного порога.
  • OFF: Мониторинг доступности отключен.

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

  • MINIMUM_THRESHOLD
  • OFF
  • PROCESS_IMPACT
minimumThreshold integer Предупреждать, если количество активных процессов в группе меньше этого значения.

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

{
  "availabilityMonitoring": {
    "method": "MINIMUM_THRESHOLD",
    "minimumThreshold": 5
  }
}

Пример

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

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

Curl

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

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

https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/processGroups/PROCESS_GROUP-52B42D0616D556F5

Тело ответа

{
  "availabilityMonitoring": {
    "method": "MINIMUM_THRESHOLD",
    "minimumThreshold": 10
  }
}

Код ответа

200