• Home
  • Dynatrace API
  • Configuration
  • Anomaly detection
  • Disk event
  • GET an event

Disk events anomaly detection API - GET an event

Gets the parameters of the specified disk event rule.

The request produces an application/json payload.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/diskEvents/{id}
SaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/anomalyDetection/diskEvents/{id}
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/diskEvents/{id}

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

ParameterTypeDescriptionInRequired
idstring

The ID of the required disk event rule.

pathrequired

Response

Response codes

CodeTypeDescription
200DiskEventAnomalyDetectionConfig

Success

Response body objects

The DiskEventAnomalyDetectionConfig object

ElementTypeDescription
metadataConfigurationMetadata

Metadata useful for debugging

idstring

The ID of the disk event rule.

namestring

The name of the disk event rule.

enabledboolean

Disk event rule enabled/disabled.

metricstring

The metric to monitor.

The element can hold these values
  • LOW_DISK_SPACE
  • LOW_INODES
  • READ_TIME_EXCEEDING
  • WRITE_TIME_EXCEEDING
thresholdnumber

The threshold to trigger disk event.

  • A percentage for LowDiskSpace or LowInodes metrics.
  • In milliseconds for ReadTimeExceeding or WriteTimeExceeding metrics.
samplesinteger

The number of samples to evaluate.

violatingSamplesinteger

The number of samples that must violate the threshold to trigger an event. Must not exceed the number of evaluated samples.

diskNameFilterDiskNameFilter

Narrows the rule usage down to disks, matching the specified criteria.

tagFiltersTagFilter[]

Narrows the rule usage down to the hosts matching the specified tags.

hostGroupIdstring

Narrows the rule usage down to disks that run on hosts that themselves run on the specified host group.

The ConfigurationMetadata object

Metadata useful for debugging

ElementTypeDescription
configurationVersionsinteger[]

A sorted list of the version numbers of the configuration.

currentConfigurationVersionsstring[]

A sorted list of version numbers of the configuration.

clusterVersionstring

Dynatrace version.

The DiskNameFilter object

Narrows the rule usage down to disks, matching the specified criteria.

ElementTypeDescription
operatorstring

Comparison operator.

The element can hold these values
  • CONTAINS
  • DOES_NOT_CONTAIN
  • DOES_NOT_EQUAL
  • DOES_NOT_START_WITH
  • EQUALS
  • STARTS_WITH
valuestring

Value to compare to.

The TagFilter object

A tag-based filter of monitored entities.

ElementTypeDescription
contextstring

The origin of the tag, such as AWS or Cloud Foundry.

Custom tags use the CONTEXTLESS value.

The element can hold these values
  • AWS
  • AWS_GENERIC
  • AZURE
  • CLOUD_FOUNDRY
  • CONTEXTLESS
  • ENVIRONMENT
  • GOOGLE_CLOUD
  • KUBERNETES
keystring

The key of the tag.

Custom tags have the tag value here.

valuestring

The value of the tag.

Not applicable to custom tags.

Response body JSON model

json
{ "metadata": { "configurationVersions": [ 4, 2 ], "currentConfigurationVersions": [ "1.0.4", "1.23" ], "clusterVersion": "1.192.1" }, "id": "string", "name": "string", "enabled": true, "metric": "LOW_DISK_SPACE", "threshold": 1, "samples": 10, "violatingSamples": 8, "diskNameFilter": { "operator": "CONTAINS", "value": "string" }, "tagFilters": [ { "context": "AWS", "key": "string", "value": "string" } ], "hostGroupId": "string" }

Example

In this example, the request lists the parameters of the low disk custom disk event rule.

The API token is passed in the Authorization header.

The rule has the following parameters:

Custom disk events rule

Curl

bash
curl -X GET \ https://mySampleEnv.live.dynatrace.com/api/config/v1/anomalyDetection/diskEvents/3f7b8234-95dc-44d0-9c1b-a5f0e8e19fd0 \ -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

plaintext
https://mySampleEnv.live.dynatrace.com/api/config/v1/anomalyDetection/diskEvents/3f7b8234-95dc-44d0-9c1b-a5f0e8e19fd0

Response body

json
{ "metadata": { "clusterVersion": "1.164.0.20190206-143829", "configurationVersions": [ 2 ] }, "id": "3f7b8234-95dc-44d0-9c1b-a5f0e8e19fd0", "name": "low disk", "enabled": true, "metric": "LOW_DISK_SPACE", "threshold": 2, "samples": 5, "violatingSamples": 3, "diskNameFilter": null, "tagFilters": [] }

Response code

200

Related topics
  • Prediction-based anomaly detection

    Read how Dynatrace automatically learns each applications’ unique traffic patterns and is thereby able to forecast the application’s traffic.

  • Davis® AI

    Get familiar with the capabilities of Davis AI.