AWS anomaly detection API - GET configuration

Gets the configuration of anomaly detection for AWS.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/anomalyDetection/aws
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/anomalyDetection/aws

Authentication

To execute this request, you need an access token with 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
ec2CandidateCpuSaturationDetectionEc2CandidateCpuSaturationDetectionConfig

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

elbHighConnectionErrorsDetectionElbHighConnectionErrorsDetectionConfig

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

lambdaHighErrorRateDetectionLambdaHighErrorRateDetectionConfig

The configuration of the AWS Lambda high error rate detection.

metadataConfigurationMetadata

Metadata useful for debugging

rdsHighCpuDetectionRdsHighCpuDetectionConfig

The configuration of the high CPU utilization on RDS detection.

rdsHighMemoryDetectionRdsHighMemoryDetectionConfig

The configuration of RDS running out of memory detection.

rdsHighWriteReadLatencyDetectionRdsHighWriteReadLatencyDetectionConfig

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

rdsLowStorageDetectionRdsLowStorageDetectionConfig

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

rdsRestartsSequenceDetectionRdsRestartsSequenceDetectionConfig

The configuration of the restarts sequence on RDS detection.

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
customThresholdsEc2CandidateCpuSaturationThresholds

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

enabledboolean

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

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.

The ElbHighConnectionErrorsDetectionConfig object

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

ElementTypeDescription
customThresholdsElbHighConnectionErrorsThresholds

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

enabledboolean

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

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 LambdaHighErrorRateDetectionConfig object

The configuration of the AWS Lambda high error rate detection.

ElementTypeDescription
customThresholdsLambdaHighErrorRateThresholds

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

enabledboolean

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

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 ConfigurationMetadata object

Metadata useful for debugging

ElementTypeDescription
clusterVersionstring

Dynatrace version.

configurationVersionsinteger[]

A sorted list of the version numbers of the configuration.

currentConfigurationVersionsstring[]

A sorted list of version numbers of the configuration.

The RdsHighCpuDetectionConfig object

The configuration of the high CPU utilization on RDS detection.

ElementTypeDescription
customThresholdsRdsHighCpuThresholds

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

enabledboolean

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

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 RdsHighMemoryDetectionConfig object

The configuration of RDS running out of memory detection.

ElementTypeDescription
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.

enabledboolean

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

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 RdsHighWriteReadLatencyDetectionConfig object

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

ElementTypeDescription
customThresholdsRdsHighLatencyThresholds

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

enabledboolean

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

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
customThresholdsRdsLowStorageThresholds

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

enabledboolean

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

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 RdsRestartsSequenceDetectionConfig object

The configuration of the restarts sequence on RDS detection.

ElementTypeDescription
customThresholdsRdsRestartsThresholds

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

enabledboolean

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

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.

Response body JSON model

{
"ec2CandidateCpuSaturationDetection": {
"customThresholds": {
"cpuUsagePercentage": 98
},
"enabled": true
},
"elbHighConnectionErrorsDetection": {
"customThresholds": {
"connectionErrorsPerMinute": 4
},
"enabled": true
},
"lambdaHighErrorRateDetection": {
"customThresholds": {
"failedInvocationsRate": 2
},
"enabled": true
},
"metadata": {
"clusterVersion": "Mock version",
"configurationVersions": [
4,
2
]
},
"rdsHighCpuDetection": {
"customThresholds": {
"cpuUsagePercentage": 99
},
"enabled": true
},
"rdsHighMemoryDetection": {
"customThresholds": {
"freeMemory": 96.99,
"swapUsage": 5.5
},
"enabled": true
},
"rdsHighWriteReadLatencyDetection": {
"customThresholds": {
"writeReadLatency": 800
},
"enabled": true
},
"rdsLowStorageDetection": {
"customThresholds": {
"freeStoragePercentage": 7
},
"enabled": true
},
"rdsRestartsSequenceDetection": {
"customThresholds": {
"restartsPerMinute": 3
},
"enabled": true
}
}

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

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

Request URL

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

Response body

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