AWS anomaly detection API - PUT configuration

Reference
Published Aug 28, 2019

Updates the configuration of anomaly detection for AWS.

The request consumes an application/json payload.

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

Authentication

To execute this request, you need an access token with WriteConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter	Type	Description	In	Required
body	AwsAnomalyDetectionConfig	JSON body of the request, containing parameters of the AWS anomaly detection configuration.	body	optional

Request body objects

The `AwsAnomalyDetectionConfig` object

The configuration of anomaly detection for AWS.

Element	Type	Description	Required
ec2CandidateCpuSaturationDetection	Ec2CandidateCpuSaturationDetectionConfig	The configuration of the high CPU saturation on EC2 without installed agent (monitoring candidate). If null, then this configuration won't be changed.	optional
elbHighConnectionErrorsDetection	ElbHighConnectionErrorsDetectionConfig	The configuration of the high number of backend connection errors on ELB detection.	required
lambdaHighErrorRateDetection	LambdaHighErrorRateDetectionConfig	The configuration of the AWS Lambda high error rate detection.	required
metadata	ConfigurationMetadata	Metadata useful for debugging	optional
rdsHighCpuDetection	RdsHighCpuDetectionConfig	The configuration of the high CPU utilization on RDS detection.	required
rdsHighMemoryDetection	RdsHighMemoryDetectionConfig	The configuration of RDS running out of memory detection.	required
rdsHighWriteReadLatencyDetection	RdsHighWriteReadLatencyDetectionConfig	The configuration of the high RDS write/read latency detection.	required
rdsLowStorageDetection	RdsLowStorageDetectionConfig	The configuration of the low free storage space on RDS detection.	required
rdsRestartsSequenceDetection	RdsRestartsSequenceDetectionConfig	The configuration of the restarts sequence on RDS detection.	required

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.

Element	Type	Description	Required
customThresholds	Ec2CandidateCpuSaturationThresholds	Custom thresholds for high CPU saturation on EC2 monitoring candidate. If not set, automatic mode is used.	optional
enabled	boolean	The detection is enabled (`true`) or disabled (`false`).	required

The `Ec2CandidateCpuSaturationThresholds` object

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

Element	Type	Description	Required
cpuUsagePercentage	integer	Alert if CPU usage is higher than X% in 3 out of 5 samples.	required

The `ElbHighConnectionErrorsDetectionConfig` object

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

Element	Type	Description	Required
customThresholds	ElbHighConnectionErrorsThresholds	Custom thresholds for high number of backend connection errors on ELB. If not set, automatic mode is used.	optional
enabled	boolean	The detection is enabled (`true`) or disabled (`false`).	required

The `ElbHighConnectionErrorsThresholds` object

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

Element	Type	Description	Required
connectionErrorsPerMinute	integer	Alert if number of backend connection errors is higher than X per minute in 3 out of 5 samples.	required

The `LambdaHighErrorRateDetectionConfig` object

The configuration of the AWS Lambda high error rate detection.

Element	Type	Description	Required
customThresholds	LambdaHighErrorRateThresholds	Custom thresholds for AWS Lambda high error rate. If not set, automatic mode is used.	optional
enabled	boolean	The detection is enabled (`true`) or disabled (`false`).	required

The `LambdaHighErrorRateThresholds` object

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

Element	Type	Description	Required
failedInvocationsRate	integer	Alert if failed invocations rate is higher than X% in 3 out of 5 samples.	required

The `ConfigurationMetadata` object

Metadata useful for debugging

Element	Type	Description	Required
clusterVersion	string	Dynatrace version.	optional
configurationVersions	integer[]	A sorted list of the version numbers of the configuration.	optional
currentConfigurationVersions	string[]	A sorted list of version numbers of the configuration.	optional

The `RdsHighCpuDetectionConfig` object

The configuration of the high CPU utilization on RDS detection.

Element	Type	Description	Required
customThresholds	RdsHighCpuThresholds	Custom thresholds for high CPU utilization on RDS. If not set, automatic mode is used.	optional
enabled	boolean	The detection is enabled (`true`) or disabled (`false`).	required

The `RdsHighCpuThresholds` object

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

Element	Type	Description	Required
cpuUsagePercentage	integer	Alert if CPU usage is higher than X% in 3 out of 5 samples.	required

The `RdsHighMemoryDetectionConfig` object

The configuration of RDS running out of memory detection.

Element Type Description Required

customThresholds

Element	Type	Description	Required
customThresholds	RdsHighMemoryThresholds	Custom thresholds for RDS running out of memory. If not set, automatic mode is used. All conditions must be fulfilled to trigger an alert.	optional
enabled	boolean	The detection is enabled (`true`) or disabled (`false`).	required

RdsHighMemoryThresholds

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

All conditions must be fulfilled to trigger an alert.

optional

enabled

boolean

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

required

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.

Element	Type	Description	Required
freeMemory	number	Freeable memory is lower than X Megabytes in 3 out of 5 samples.	required
swapUsage	number	Swap usage is higher than X Gigabytes in 3 out of 5 samples.	required

The `RdsHighWriteReadLatencyDetectionConfig` object

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

Element	Type	Description	Required
customThresholds	RdsHighLatencyThresholds	Custom thresholds for high RDS write/read latency. If not set, automatic mode is used	optional
enabled	boolean	The detection is enabled (`true`) or disabled (`false`).	required

The `RdsHighLatencyThresholds` object

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

Element	Type	Description	Required
writeReadLatency	integer	Alert if read/write latency is higher than X milliseconds in 3 out of 5 samples.	required

The `RdsLowStorageDetectionConfig` object

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

Element	Type	Description	Required
customThresholds	RdsLowStorageThresholds	Custom thresholds for low free storage space on RDS. If not set, automatic mode is used.	optional
enabled	boolean	The detection is enabled (`true`) or disabled (`false`).	required

The `RdsLowStorageThresholds` object

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

Element	Type	Description	Required
freeStoragePercentage	integer	Alert if free storage space divided by allocated storage is lower than X% in 3 out of 5 samples.	required

The `RdsRestartsSequenceDetectionConfig` object

The configuration of the restarts sequence on RDS detection.

Element	Type	Description	Required
customThresholds	RdsRestartsThresholds	Custom thresholds for restarts sequence on RDS. If not set, automatic mode is used.	optional
enabled	boolean	The detection is enabled (`true`) or disabled (`false`).	required

The `RdsRestartsThresholds` object

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

Element	Type	Description	Required
restartsPerMinute	integer	Alert if number of restarts is X per minute or higher in 3 out of 20 samples.	required

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

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

Response

Response codes

Code	Type	Description
204	-	Success. Configuration has been updated. Response doesn't have a body.
400	ErrorEnvelope	Failed. The input is invalid.

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

The request consumes an application/json payload.

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

Authentication

To execute this request, you need an access token with WriteConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Response

Response codes

Code	Type	Description
204	-	Validated. The submitted configuration is valid. Response doesn't have a body.
400	ErrorEnvelope	Failed. The input is invalid.

Example

In this example, the request updates the configuration of anomaly detection for AWS from the GET request example. It switches high CPU utilization on RDS detection to custom threshold mode and sets a threshold of 90%. It also disables RDS running out of memory detection.

The API token is passed in the Authorization header.

You can download or copy the example request body to try it out on your own. Be sure to create a backup copy of your current configuration with the GET AWS anomaly detection configuration call.

Curl

curl -X PUT \
  https://mySampleEnv.live.dynatrace.com/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
  }
}
'

Request URL

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

Request body

{
  "rdsHighCpuDetection": {
    "enabled": true,
    "customThresholds": {
      "cpuUsagePercentage": 90
    }
  },
  "rdsHighWriteReadLatencyDetection": {
    "enabled": true
  },
  "rdsLowStorageDetection": {
    "enabled": true
  },
  "rdsHighMemoryDetection": {
    "enabled": false
  },
  "elbHighConnectionErrorsDetection": {
    "enabled": true
  },
  "rdsRestartsSequenceDetection": {
    "enabled": true
  },
  "lambdaHighErrorRateDetection": {
    "enabled": true
  }
}

Response code

204

Result

The updated configuration has the following parameters:

AWS anomaly detection API - PUT configuration

Authentication

Parameters

Request body objects

The AwsAnomalyDetectionConfig object

The Ec2CandidateCpuSaturationDetectionConfig object

The Ec2CandidateCpuSaturationThresholds object

The ElbHighConnectionErrorsDetectionConfig object

The ElbHighConnectionErrorsThresholds object

The LambdaHighErrorRateDetectionConfig object

The LambdaHighErrorRateThresholds object

The ConfigurationMetadata object

The RdsHighCpuDetectionConfig object

The RdsHighCpuThresholds object

The RdsHighMemoryDetectionConfig object

The RdsHighMemoryThresholds object

The RdsHighWriteReadLatencyDetectionConfig object

The RdsHighLatencyThresholds object

The RdsLowStorageDetectionConfig object

The RdsLowStorageThresholds object

The RdsRestartsSequenceDetectionConfig object

The RdsRestartsThresholds object

Request body JSON model

Response

Response codes

Validate payload

Authentication

Response

Response codes

Example

Curl

Request URL

Request body

Response code

Result

Related topics

The `AwsAnomalyDetectionConfig` object

The `Ec2CandidateCpuSaturationDetectionConfig` object

The `Ec2CandidateCpuSaturationThresholds` object

The `ElbHighConnectionErrorsDetectionConfig` object

The `ElbHighConnectionErrorsThresholds` object

The `LambdaHighErrorRateDetectionConfig` object

The `LambdaHighErrorRateThresholds` object

The `ConfigurationMetadata` object

The `RdsHighCpuDetectionConfig` object

The `RdsHighCpuThresholds` object

The `RdsHighMemoryDetectionConfig` object

The `RdsHighMemoryThresholds` object

The `RdsHighWriteReadLatencyDetectionConfig` object

The `RdsHighLatencyThresholds` object

The `RdsLowStorageDetectionConfig` object

The `RdsLowStorageThresholds` object

The `RdsRestartsSequenceDetectionConfig` object

The `RdsRestartsThresholds` object