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

Получает конфигурацию обнаружения аномалий для AWS.

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

GET	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

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

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

Параметры

Запрос не предоставляет никаких настраиваемых параметров.

Ответ

Коды ответов

Код	Тип	Описание
200	AwsAnomalyDetectionConfig	Успех

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

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

Пример

В этом примере в запросе указана текущая конфигурация обнаружения аномалий для AWS.

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

Конфигурация имеет следующие настройки:

Curl

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

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

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

Тело ответа

{
  "metadata": {
    "clusterVersion": "1.163.2.20190201-072431",
    "configurationVersions": [
      8,
      2
    ]
  },
  "rdsHighCpuDetection": {
    "enabled": true
  },
  "rdsHighWriteReadLatencyDetection": {
    "enabled": true
  },
  "rdsLowStorageDetection": {
    "enabled": true
  },
  "rdsHighMemoryDetection": {
    "enabled": true
  },
  "elbHighConnectionErrorsDetection": {
    "enabled": true
  },
  "rdsRestartsSequenceDetection": {
    "enabled": true
  },
  "lambdaHighErrorRateDetection": {
    "enabled": true
  }
}

Код ответа

200