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

Материал из Документация Ключ-АСТРОМ

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

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

PUT Ключ-АСТРОМ 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}

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

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

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

Параметры

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

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

Объект 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
  }
}

Ответ

Коды ответов

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

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

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

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

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

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

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

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

Ответ

Коды ответов

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

Пример

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

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

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

Curl

curl -L -X PUT 'https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/processGroups/PROCESS_GROUP-52B42D0616D556F5' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
--data-raw '{
    "availabilityMonitoring": {
        "method": "PROCESS_IMPACT"
    }
}'

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

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

Тело запроса

{
  "availabilityMonitoring": {
    "method": "PROCESS_IMPACT"
  }
}

Код ответа

204

Результат

Prgr1.png

Источник — https://doc.ruscomtech.ru/index.php?title=API_обнаружения_аномалий_групп_процессов_-_PUT_конфигурация&oldid=3308