Disk events anomaly detection API - GET an event

  • Reference
  • Published Aug 29, 2019

Gets the parameters of the specified disk event rule.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/anomalyDetection/diskEvents/{id}
Environment ActiveGatehttps://{your-activegate-domain}:9999/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
diskNameFilterDiskNameFilter

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

enabledboolean

Disk event rule enabled/disabled.

hostGroupIdstring

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

idstring

The ID of the disk event rule.

metadataConfigurationMetadata

Metadata useful for debugging

metricstring

The metric to monitor.

  • LOW_DISK_SPACE
  • LOW_INODES
  • READ_TIME_EXCEEDING
  • WRITE_TIME_EXCEEDING
namestring

The name of the disk event rule.

samplesinteger

The number of samples to evaluate.

tagFiltersTagFilter[]

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

thresholdnumber

The threshold to trigger disk event.

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

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

The DiskNameFilter object

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

ElementTypeDescription
operatorstring

Comparison operator.

  • CONTAINS
  • DOES_NOT_CONTAIN
  • DOES_NOT_EQUAL
  • DOES_NOT_START_WITH
  • EQUALS
  • STARTS_WITH
valuestring

Value to compare to.

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

  • 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

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

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

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

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

Response body

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