• Home
  • Dynatrace API
  • Configuration
  • Anomaly detection
  • AWS
  • GET configuration

AWS anomaly detection API - GET configuration

Gets the configuration of anomaly detection for AWS.

The request produces an application/json payload.

GETManaged https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/aws
SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/anomalyDetection/aws
Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/aws

Authentication

To execute this request, you need an access token with Read configuration (ReadConfig) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

The request doesn't provide any configurable parameters.

Response

Response codes

CodeTypeDescription
200AwsAnomalyDetectionConfig

Success

Response body objects

The AwsAnomalyDetectionConfig object

The configuration of anomaly detection for AWS.

ElementTypeDescription
metadataConfigurationMetadata

Metadata useful for debugging

Can be null.

rdsHighCpuDetectionRdsHighCpuDetectionConfig

The configuration of the high CPU utilization on RDS detection.

rdsHighWriteReadLatencyDetectionRdsHighWriteReadLatencyDetectionConfig

The configuration of the high RDS write/read latency detection.

rdsLowStorageDetectionRdsLowStorageDetectionConfig

The configuration of the low free storage space on RDS detection.

rdsHighMemoryDetectionRdsHighMemoryDetectionConfig

The configuration of RDS running out of memory detection.

elbHighConnectionErrorsDetectionElbHighConnectionErrorsDetectionConfig

The configuration of the high number of backend connection errors on ELB detection.

rdsRestartsSequenceDetectionRdsRestartsSequenceDetectionConfig

The configuration of the restarts sequence on RDS detection.

lambdaHighErrorRateDetectionLambdaHighErrorRateDetectionConfig

The configuration of the AWS Lambda high error rate detection.

ec2CandidateCpuSaturationDetectionEc2CandidateCpuSaturationDetectionConfig

The configuration of the high CPU saturation on EC2 without installed agent (monitoring candidate). If null, then this configuration won't be changed.

Can be null.

The ConfigurationMetadata object

Metadata useful for debugging

ElementTypeDescription
configurationVersionsinteger[]

A sorted list of the version numbers of the configuration.

Can be null.

currentConfigurationVersionsstring[]

A sorted list of version numbers of the configuration.

Can be null.

clusterVersionstring

Dynatrace version.

Can be null.

The RdsHighCpuDetectionConfig object

The configuration of the high CPU utilization on RDS detection.

ElementTypeDescription
enabledboolean

The detection is enabled (true) or disabled (false).

customThresholdsRdsHighCpuThresholds

Custom thresholds for high CPU utilization on RDS. If not set, automatic mode is used.

Can be null.

The RdsHighCpuThresholds object

Custom thresholds for high CPU utilization on RDS. If not set, automatic mode is used.

ElementTypeDescription
cpuUsagePercentageinteger

Alert if CPU usage is higher than X% in 3 out of 5 samples.

The RdsHighWriteReadLatencyDetectionConfig object

The configuration of the high RDS write/read latency detection.

ElementTypeDescription
enabledboolean

The detection is enabled (true) or disabled (false).

customThresholdsRdsHighLatencyThresholds

Custom thresholds for high RDS write/read latency. If not set, automatic mode is used

Can be null.

The RdsHighLatencyThresholds object

Custom thresholds for high RDS write/read latency. If not set, automatic mode is used

ElementTypeDescription
writeReadLatencyinteger

Alert if read/write latency is higher than X milliseconds in 3 out of 5 samples.

The RdsLowStorageDetectionConfig object

The configuration of the low free storage space on RDS detection.

ElementTypeDescription
enabledboolean

The detection is enabled (true) or disabled (false).

customThresholdsRdsLowStorageThresholds

Custom thresholds for low free storage space on RDS. If not set, automatic mode is used.

Can be null.

The RdsLowStorageThresholds object

Custom thresholds for low free storage space on RDS. If not set, automatic mode is used.

ElementTypeDescription
freeStoragePercentageinteger

Alert if free storage space divided by allocated storage is lower than X% in 3 out of 5 samples.

The RdsHighMemoryDetectionConfig object

The configuration of RDS running out of memory detection.

ElementTypeDescription
enabledboolean

The detection is enabled (true) or disabled (false).

customThresholdsRdsHighMemoryThresholds

Custom thresholds for RDS running out of memory. If not set, automatic mode is used.

All conditions must be fulfilled to trigger an alert.

Can be null.

The RdsHighMemoryThresholds object

Custom thresholds for RDS running out of memory. If not set, automatic mode is used.

All conditions must be fulfilled to trigger an alert.

ElementTypeDescription
freeMemorynumber

Freeable memory is lower than X Megabytes in 3 out of 5 samples.

swapUsagenumber

Swap usage is higher than X Gigabytes in 3 out of 5 samples.

The ElbHighConnectionErrorsDetectionConfig object

The configuration of the high number of backend connection errors on ELB detection.

ElementTypeDescription
enabledboolean

The detection is enabled (true) or disabled (false).

customThresholdsElbHighConnectionErrorsThresholds

Custom thresholds for high number of backend connection errors on ELB. If not set, automatic mode is used.

Can be null.

The ElbHighConnectionErrorsThresholds object

Custom thresholds for high number of backend connection errors on ELB. If not set, automatic mode is used.

ElementTypeDescription
connectionErrorsPerMinuteinteger

Alert if number of backend connection errors is higher than X per minute in 3 out of 5 samples.

The RdsRestartsSequenceDetectionConfig object

The configuration of the restarts sequence on RDS detection.

ElementTypeDescription
enabledboolean

The detection is enabled (true) or disabled (false).

customThresholdsRdsRestartsThresholds

Custom thresholds for restarts sequence on RDS. If not set, automatic mode is used.

Can be null.

The RdsRestartsThresholds object

Custom thresholds for restarts sequence on RDS. If not set, automatic mode is used.

ElementTypeDescription
restartsPerMinuteinteger

Alert if number of restarts is X per minute or higher in 3 out of 20 samples.

The LambdaHighErrorRateDetectionConfig object

The configuration of the AWS Lambda high error rate detection.

ElementTypeDescription
enabledboolean

The detection is enabled (true) or disabled (false).

customThresholdsLambdaHighErrorRateThresholds

Custom thresholds for AWS Lambda high error rate. If not set, automatic mode is used.

Can be null.

The LambdaHighErrorRateThresholds object

Custom thresholds for AWS Lambda high error rate. If not set, automatic mode is used.

ElementTypeDescription
failedInvocationsRateinteger

Alert if failed invocations rate is higher than X% in 3 out of 5 samples.

The Ec2CandidateCpuSaturationDetectionConfig object

The configuration of the high CPU saturation on EC2 without installed agent (monitoring candidate). If null, then this configuration won't be changed.

ElementTypeDescription
enabledboolean

The detection is enabled (true) or disabled (false).

customThresholdsEc2CandidateCpuSaturationThresholds

Custom thresholds for high CPU saturation on EC2 monitoring candidate. If not set, automatic mode is used.

Can be null.

The Ec2CandidateCpuSaturationThresholds object

Custom thresholds for high CPU saturation on EC2 monitoring candidate. If not set, automatic mode is used.

ElementTypeDescription
cpuUsagePercentageinteger

Alert if CPU usage is higher than X% in 3 out of 5 samples.

Response body JSON model

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 } } }

Example

In this example, the request lists the current configuration of anomaly detection for AWS.

The API token is passed in the Authorization header.

The configuration has the following settings:

Anomaly detection config - AWS

Curl

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

Request URL

plaintext
https://mySampleEnv.live.dynatrace.com/api/config/v1/anomalyDetection/aws

Response body

json
{ "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 } }

Response code

200

Related topics
  • Adjust the sensitivity of anomaly detection for infrastructure

    Adjust problem detection sensitivity for infrastructure.

  • Problem detection and analysis

    Understand the basic concepts related to how Dynatrace detects and raises alerts for problems detected in your environment.