AWS обнаружение аномалий API - PUT конфигурация: различия между версиями
ENetrebin (обсуждение | вклад) (Новая страница: «Обновляет конфигурацию обнаружения аномалий для AWS. Запрос использует в качестве полез...») |
ENetrebin (обсуждение | вклад) |
||
| Строка 569: | Строка 569: | ||
==== Результат ==== | ==== Результат ==== | ||
Обновленная конфигурация имеет следующие параметры: | Обновленная конфигурация имеет следующие параметры: | ||
[[Файл:aws2.png]] | |||
Текущая версия на 13:58, 27 октября 2022
Обновляет конфигурацию обнаружения аномалий для AWS.
Запрос использует в качестве полезной нагрузки application/json формат.
| PUT | Managed | https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/aws
|
| Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/aws
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Запись конфигурации ( WriteConfig) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | In | Необходимость |
|---|---|---|---|---|
| body | AwsAnomalyDetectionConfig | Тело запроса в формате JSON, содержащее параметры конфигурации обнаружения аномалий AWS. | body | по желанию |
Объекты тела запроса
Объект AwsAnomalyDetectionConfig
Конфигурация обнаружения аномалий для AWS.
| Элемент | Тип | Описание | Необходимость |
|---|---|---|---|
| metadata | ConfigurationMetadata | Метаданные, полезные для отладки | по желанию |
| rdsHighCpuDetection | RdsHighCpuDetectionConfig | Конфигурация высокой загрузки ЦП при обнаружении RDS. | требуется |
| rdsHighWriteReadLatencyDetection | RdsHighWriteReadLatencyDetectionConfig | Конфигурация обнаружения высокой задержки записи/чтения RDS. | требуется |
| rdsLowStorageDetection | RdsLowStorageDetectionConfig | Конфигурация низкого свободного места на диске при обнаружении RDS. | требуется |
| rdsHighMemoryDetection | RdsHighMemoryDetectionConfig | Конфигурация RDS с обнаружением нехватки памяти. | требуется |
| elbHighConnectionErrorsDetection | ElbHighConnectionErrorsDetectionConfig | Конфигурация большого количества ошибок соединения с серверной частью при обнаружении ELB. | требуется |
| rdsRestartsSequenceDetection | RdsRestartsSequenceDetectionConfig | Конфигурация последовательности перезапусков при обнаружении RDS. | требуется |
| lambdaHighErrorRateDetection | LambdaHighErrorRateDetectionConfig | Конфигурация обнаружения высокой частоты ошибок AWS Lambda. | требуется |
| ec2CandidateCpuSaturationDetection | Ec2CandidateCpuSaturationDetectionConfig | Конфигурация высокой загрузки ЦП на EC2 без установленного агента (кандидат на мониторинг). Если null, то эта конфигурация не будет изменена. | по желанию |
Объект ConfigurationMetadata
Метаданные, полезные для отладки
| Элемент | Тип | Описание | Необходимость |
|---|---|---|---|
| configurationVersions | integer[] | Отсортированный список номеров версий конфигурации. | по желанию |
| currentConfigurationVersions | string[] | Отсортированный список номеров версий конфигурации. | по желанию |
| clusterVersion | string | Версия Ключ-АСТРОМ. | по желанию |
Объект RdsHighCpuDetectionConfig
Конфигурация высокой загрузки ЦП при обнаружении RDS.
| Элемент | Тип | Описание | Необходимость |
|---|---|---|---|
| enabled | boolean | Обнаружение включено ( true) или отключено ( false).
|
требуется |
| customThresholds | RdsHighCpuThresholds | Пользовательские пороги высокой загрузки ЦП в RDS. Если не установлено, используется автоматический режим. | по желанию |
Объект RdsHighCpuThresholds
Пользовательские пороги высокой загрузки ЦП в RDS. Если не установлено, используется автоматический режим.
| Элемент | Тип | Описание | Необходимость |
|---|---|---|---|
| cpuUsagePercentage | integer | Предупреждать, если загрузка ЦП превышает X % в 3 из 5 выборок. | требуется |
Объект RdsHighWriteReadLatencyDetectionConfig
Конфигурация обнаружения высокой задержки записи/чтения RDS.
| Элемент | Тип | Описание | Необходимость |
|---|---|---|---|
| enabled | boolean | Обнаружение включено ( true) или отключено ( false).
|
требуется |
| customThresholds | RdsHighLatencyThresholds | Пользовательские пороговые значения для высокой задержки записи/чтения RDS. Если не установлено, используется автоматический режим | по желанию |
Объект RdsHighLatencyThresholds
Пользовательские пороговые значения для высокой задержки записи/чтения RDS. Если не установлено, используется автоматический режим
| Элемент | Тип | Описание | Необходимость |
|---|---|---|---|
| writeReadLatency | integer | Оповещение, если задержка чтения/записи превышает X миллисекунд в 3 из 5 выборок. | требуется |
Объект _ RdsLowStorageDetectionConfig
Конфигурация низкого свободного места на диске при обнаружении RDS.
| Элемент | Тип | Описание | Необходимость |
|---|---|---|---|
| enabled | boolean | Обнаружение включено ( true) или отключено ( false).
|
требуется |
| customThresholds | RdsLowStorageThresholds | Пользовательские пороги для низкого свободного места на RDS. Если не установлено, используется автоматический режим. | по желанию |
Объект RdsLowStorageThresholds
Пользовательские пороги для низкого свободного места на RDS. Если не установлено, используется автоматический режим.
| Элемент | Тип | Описание | Необходимость |
|---|---|---|---|
| freeStoragePercentage | integer | Предупреждать, если свободное пространство хранения, разделенное на выделенное хранилище, меньше X % в 3 из 5 выборок. | требуется |
Объект RdsHighMemoryDetectionConfig
Конфигурация RDS с обнаружением нехватки памяти.
| Элемент | Тип | Описание | Необходимость |
|---|---|---|---|
| enabled | boolean | Обнаружение включено ( true) или отключено ( false).
|
требуется |
| customThresholds | RdsHighMemoryThresholds | Пользовательские пороги для RDS, у которых заканчивается память. Если не установлено, используется автоматический режим.
Для срабатывания оповещения должны быть выполнены все условия. |
по желанию |
Объект RdsHighMemoryThresholds
Пользовательские пороги для RDS, у которых заканчивается память. Если не установлено, используется автоматический режим.
Для срабатывания оповещения должны быть выполнены все условия.
| Элемент | Тип | Описание | Необходимость |
|---|---|---|---|
| freeMemory | number | Свободная память меньше X мегабайт в 3 из 5 образцов. | требуется |
| swapUsage | number | Использование подкачки превышает X гигабайт в 3 из 5 образцов. | требуется |
Объект ElbHighConnectionErrorsDetectionConfig
Конфигурация большого количества ошибок соединения с серверной частью при обнаружении ELB.
| Элемент | Тип | Описание | Необходимость |
|---|---|---|---|
| enabled | boolean | Обнаружение включено ( true) или отключено ( false).
|
требуется |
| customThresholds | ElbHighConnectionErrorsThresholds | Пользовательские пороги для большого количества ошибок соединения с серверной частью на ELB. Если не установлено, используется автоматический режим. | по желанию |
Объект ElbHighConnectionErrorsThresholds
Пользовательские пороги для большого количества ошибок соединения с серверной частью на ELB. Если не установлено, используется автоматический режим.
| Элемент | Тип | Описание | Необходимость |
|---|---|---|---|
| connectionErrorsPerMinute | integer | Оповещение, если количество ошибок соединения с серверной частью превышает X в минуту в 3 из 5 выборок. | требуется |
Объект RdsRestartsSequenceDetectionConfig
Конфигурация последовательности перезапусков при обнаружении RDS.
| Элемент | Тип | Описание | Необходимость |
|---|---|---|---|
| enabled | boolean | Обнаружение включено ( true) или отключено ( false).
|
требуется |
| customThresholds | RdsRestartsThresholds | Пользовательские пороги для последовательности перезапусков в RDS. Если не установлено, используется автоматический режим. | по желанию |
Объект RdsRestartsThresholds
Пользовательские пороги для последовательности перезапусков в RDS. Если не установлено, используется автоматический режим.
| Элемент | Тип | Описание | Необходимость |
|---|---|---|---|
| restartsPerMinute | integer | Предупреждать, если количество перезапусков X в минуту или выше в 3 из 20 образцов. | требуется |
Объект LambdaHighErrorRateDetectionConfig
Конфигурация обнаружения высокой частоты ошибок AWS Lambda.
| Элемент | Тип | Описание | Необходимость |
|---|---|---|---|
| enabled | boolean | Обнаружение включено ( true) или отключено ( false).
|
требуется |
| customThresholds | LambdaHighErrorRateThresholds | Пользовательские пороговые значения для высокой частоты ошибок AWS Lambda. Если не установлено, используется автоматический режим. | по желанию |
Объект LambdaHighErrorRateThresholds
Пользовательские пороговые значения для высокой частоты ошибок AWS Lambda. Если не установлено, используется автоматический режим.
| Элемент | Тип | Описание | Необходимость |
|---|---|---|---|
| failedInvocationsRate | integer | Оповещение, если частота неудачных вызовов превышает X % в 3 из 5 выборок. | требуется |
Объект Ec2CandidateCpuSaturationDetectionConfig
Конфигурация высокой загрузки ЦП на EC2 без установленного агента (кандидат на мониторинг). Если null, то эта конфигурация не будет изменена.
| Элемент | Тип | Описание | Необходимость |
|---|---|---|---|
| enabled | boolean | Обнаружение включено ( true) или отключено ( false).
|
требуется |
| customThresholds | Ec2CandidateCpuSaturationThresholds | Пользовательские пороги высокой загрузки ЦП для кандидата на мониторинг EC2. Если не установлено, используется автоматический режим. | по желанию |
Объект Ec2CandidateCpuSaturationThresholds
Пользовательские пороги высокой загрузки ЦП для кандидата на мониторинг EC2. Если не установлено, используется автоматический режим.
| Элемент | Тип | Описание | Необходимость |
|---|---|---|---|
| cpuUsagePercentage | integer | Предупреждать, если загрузка ЦП превышает X % в 3 из 5 выборок. | требуется |
JSON-модель тела запроса
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
{
"metadata": {
"configurationVersions": [
4,
2
],
"clusterVersion": "Mock version"
},
"rdsHighCpuDetection": {
"enabled": true,
"customThresholds": {
"cpuUsagePercentage": 99
}
},
"rdsHighWriteReadLatencyDetection": {
"enabled": true,
"customThresholds": {
"writeReadLatency": 800
}
},
"rdsLowStorageDetection": {
"enabled": true,
"customThresholds": {
"freeStoragePercentage": 7
}
},
"rdsHighMemoryDetection": {
"enabled": true,
"customThresholds": {
"freeMemory": 96.99,
"swapUsage": 5.5
}
},
"elbHighConnectionErrorsDetection": {
"enabled": true,
"customThresholds": {
"connectionErrorsPerMinute": 4
}
},
"rdsRestartsSequenceDetection": {
"enabled": true,
"customThresholds": {
"restartsPerMinute": 3
}
},
"lambdaHighErrorRateDetection": {
"enabled": true,
"customThresholds": {
"failedInvocationsRate": 2
}
},
"ec2CandidateCpuSaturationDetection": {
"enabled": true,
"customThresholds": {
"cpuUsagePercentage": 98
}
}
}
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 204 | Успех. Конфигурация обновлена. Ответ не имеет тела. | |
| 400 | ErrorEnvelope | Не удалось. Ввод недействителен. |
Проверка полезной нагрузки
Мы рекомендуем вам проверить полезную нагрузку перед ее отправкой с фактическим запросом. Код ответа 204 указывает на действительную полезную нагрузку.
Запрос использует в качестве полезной нагрузки application/json формат.
| POST | Managed | https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/aws/validator
|
| Среда ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/aws/validator
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Запись конфигурации ( WriteConfig) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 204 | Подтверждено. Представленная конфигурация действительна. Ответ не имеет тела. | |
| 400 | ErrorEnvelope | Не удалось. Ввод недействителен. |
Пример
В этом примере запрос обновляет конфигурацию обнаружения аномалий для AWS из примера запроса GET . Он переключает высокую загрузку ЦП при обнаружении RDS в режим настраиваемого порога и устанавливает порог 90 %. Он также отключает обнаружение нехватки памяти RDS .
Маркер API передается в заголовке авторизации .
Вы можете скачать или скопировать образец тела запроса, чтобы попробовать его самостоятельно. Обязательно создайте резервную копию текущей конфигурации с помощью вызова конфигурации GET AWS для обнаружения аномалий .
Curl
curl -X PUT \
https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/aws \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
-d '{
"rdsHighCpuDetection": {
"enabled": true,
"customThresholds": {
"cpuUsagePercentage": 90
}
},
"rdsHighWriteReadLatencyDetection": {
"enabled": true
},
"rdsLowStorageDetection": {
"enabled": true
},
"rdsHighMemoryDetection": {
"enabled": false
},
"elbHighConnectionErrorsDetection": {
"enabled": true
},
"rdsRestartsSequenceDetection": {
"enabled": true
},
"lambdaHighErrorRateDetection": {
"enabled": true
}
}
'
URL-адрес запроса
https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/aws
Тело запроса
{
"rdsHighCpuDetection": {
"enabled": true,
"customThresholds": {
"cpuUsagePercentage": 90
}
},
"rdsHighWriteReadLatencyDetection": {
"enabled": true
},
"rdsLowStorageDetection": {
"enabled": true
},
"rdsHighMemoryDetection": {
"enabled": false
},
"elbHighConnectionErrorsDetection": {
"enabled": true
},
"rdsRestartsSequenceDetection": {
"enabled": true
},
"lambdaHighErrorRateDetection": {
"enabled": true
}
}
Код ответа
204
Результат
Обновленная конфигурация имеет следующие параметры:
