Обнаружение аномалий дисковых событий API - POST событие

Материал из Документация Ключ-АСТРОМ
Версия от 16:35, 27 октября 2022; ENetrebin (обсуждение | вклад) (→‎Результат)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

Создает новое правило событий диска.

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

POST Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/diskEvents
Среда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/diskEvents

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

Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Запись конфигурации ( WriteConfig) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Параметр Тип Описание In Необходимость
body DiskEventAnomalyDetectionConfig Тело запроса в формате JSON. Содержит параметры нового правила событий диска. body по желанию

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

Объект DiskEventAnomalyDetectionConfig

Элемент Тип Описание Необходимость
metadata ConfigurationMetadata Метаданные, полезные для отладки по желанию
id string Идентификатор правила события диска. по желанию
name string Имя правила событий диска. требуется
enabled boolean Правило событий диска включено/выключено. требуется
metric string Метрика для мониторинга.

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

  • LOW_DISK_SPACE
  • LOW_INODES
  • READ_TIME_EXCEEDING
  • WRITE_TIME_EXCEEDING
 требуется
threshold number Порог для срабатывания дискового события.
  • Процент для LowDiskSpaceили LowInodesпоказателей.
  • В миллисекундах для ReadTimeExceedingили WriteTimeExceedingметрик.
 требуется
samples integer Количество образцов для оценки. требуется
violatingSamples integer Количество выборок, которые должны нарушить пороговое значение, чтобы вызвать событие. Не должно превышать количество оцениваемых образцов. требуется
diskNameFilter DiskNameFilter Сужает использование правила до дисков, соответствующих указанным критериям. по желанию
tagFilters TagFilter[] Сужает использование правила до хостов, соответствующих указанным тегам. по желанию
hostGroupId string Сужает использование правила до дисков, которые работают на хостах, которые сами работают в указанной группе хостов. по желанию

Объект ConfigurationMetadata

Метаданные, полезные для отладки

Элемент Тип Описание Необходимость
configurationVersions integer[] Отсортированный список номеров версий конфигурации. по желанию
currentConfigurationVersions string[] Отсортированный список номеров версий конфигурации. по желанию
clusterVersion string Версия Ключ-АСТРОМ. по желанию

Объект DiskNameFilter

Сужает использование правила до дисков, соответствующих указанным критериям.

Элемент Тип Описание Необходимость
operator string Оператор сравнения.

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

  • CONTAINS
  • DOES_NOT_CONTAIN
  • DOES_NOT_EQUAL
  • DOES_NOT_START_WITH
  • EQUALS
  • STARTS_WITH
 требуется
value string Значение для сравнения. требуется

Объект TagFilter

Фильтр контролируемых объектов на основе тегов.

Элемент Тип Описание Необходимость
context string Происхождение тега, например AWS или Cloud Foundry.

Пользовательские теги используют это CONTEXTLESSзначение.

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

  • AWS
  • AWS_GENERIC
  • AZURE
  • CLOUD_FOUNDRY
  • CONTEXTLESS
  • ENVIRONMENT
  • GOOGLE_CLOUD
  • KUBERNETES
 требуется
key string Ключ тега.

Пользовательские теги имеют значение тега здесь.

требуется
value string Значение тега.

Не применимо к пользовательским тегам.

по желанию

JSON-модель тела запроса

Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе. 

{
  "metadata": {
    "configurationVersions": [
      4,
      2
    ],
    "currentConfigurationVersions": [
      "1.0.4",
      "1.23"
    ],
    "clusterVersion": "1.192.1"
  },
  "id": "string",
  "name": "string",
  "enabled": true,
  "metric": "LOW_DISK_SPACE",
  "threshold": 1,
  "samples": 10,
  "violatingSamples": 8,
  "diskNameFilter": {
    "operator": "CONTAINS",
    "value": "string"
  },
  "tagFilters": [
    {
      "context": "AWS",
      "key": "string",
      "value": "string"
    }
  ],
  "hostGroupId": "string"
}

Ответ

Коды ответов

Код Тип Описание
201 EntityShortRepresentation Успех. Создано новое правило событий диска. Возвращается идентификатор нового правила событий диска.
400 ErrorEnvelope Не удалось. Ввод недействителен

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

Объект EntityShortRepresentation

Краткое представление объекта Ключ-АСТРОМ.

Элемент Тип Описание
id string Идентификатор объекта Ключ-АСТРОМ.
name string Имя объекта Ключ-АСТРОМ.
description string Краткое описание объекта Ключ-АСТРОМ.

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

{
  "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
  "name": "Astromkey entity",
  "description": "Astromkey entity for the REST API example"
}

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

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

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

POST Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/diskEvents/validator
Среда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/diskEvents/validator

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

Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Запись конфигурации ( WriteConfig) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Ответ

Коды ответов

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

Пример

В этом примере запрос создает новое пользовательское правило события диска с именем очень медленный диск . Правило запускает предупреждение для любого диска, имя которого начинается сC и время чтения которого превышает 200 миллисекунд в 8 из 10 выборок.

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

Вы можете скачать или скопировать образец тела запроса, чтобы попробовать его самостоятельно.

Curl

curl -X POST \
  https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/diskEvents \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "very slow disk",
  "enabled": true,
  "metric": "READ_TIME_EXCEEDING",
  "threshold": 200,
  "samples": 10,
  "violatingSamples": 8,
  "diskNameFilter": {
    "operator": "STARTS_WITH",
    "value": "C"
  },
  "tagFilters": []
}
'

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

https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/diskEvents

Тело запроса

{
  "name": "very slow disk",
  "enabled": true,
  "metric": "READ_TIME_EXCEEDING",
  "threshold": 200,
  "samples": 10,
  "violatingSamples": 8,
  "diskNameFilter": {
    "operator": "STARTS_WITH",
    "value": "C"
  },
  "tagFilters": []
}

Тело ответа

{
  "id": "fdd83212-9c08-44ba-a0cf-dbb471cd819a",
  "name": "very slow disk"
}

Код ответа

204

Результат

Новое правило выглядит так в пользовательском интерфейсе:

Disk3.png

Источник — https://doc.ruscomtech.ru/index.php?title=Обнаружение_аномалий_дисковых_событий_API_-_POST_событие&oldid=1952