Disk events anomaly detection API - GET an event

Gets the parameters of the specified disk event rule.

The request produces an application/json payload.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

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

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

Parameter	Type	Description	In	Required
id	string	The ID of the required disk event rule.	path	required

Response

Response codes

Code	Type	Description
200	DiskEventAnomalyDetectionConfig	Success

Response body objects

The `DiskEventAnomalyDetectionConfig` object

Element	Type	Description
metadata	ConfigurationMetadata	Metadata useful for debugging Can be `null`.
id	string	The ID of the disk event rule. Can be `null`.
name	string	The name of the disk event rule.
enabled	boolean	Disk event rule enabled/disabled.
metric	string	The metric to monitor. The element can hold these values `LOW_DISK_SPACE` `LOW_INODES` `READ_TIME_EXCEEDING` `WRITE_TIME_EXCEEDING`
threshold	number	The threshold to trigger disk event. A percentage for `LowDiskSpace` or `LowInodes` metrics. In milliseconds for `ReadTimeExceeding` or `WriteTimeExceeding` metrics.
samples	integer	The number of samples to evaluate.
violatingSamples	integer	The number of samples that must violate the threshold to trigger an event. Must not exceed the number of evaluated samples.
diskNameFilter	DiskNameFilter	Narrows the rule usage down to disks, matching the specified criteria. Can be `null`.
tagFilters	TagFilter[]	Narrows the rule usage down to the hosts matching the specified tags. Can be `null`.
hostGroupId	string	Narrows the rule usage down to disks that run on hosts that themselves run on the specified host group. Can be `null`.

The `ConfigurationMetadata` object

Metadata useful for debugging

Element Type Description

configurationVersions

integer[]

Element	Type	Description
configurationVersions	integer[]	A sorted list of the version numbers of the configuration. Can be `null`.
currentConfigurationVersions	string[]	A sorted list of version numbers of the configuration. Can be `null`.
clusterVersion	string	Dynatrace version. Can be `null`.

A sorted list of the version numbers of the configuration.

Can be null.

currentConfigurationVersions

string[]

A sorted list of version numbers of the configuration.

Can be null.

clusterVersion

string

Dynatrace version.

Can be null.

The `DiskNameFilter` object

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

Element	Type	Description
operator	string	Comparison operator. The element can hold these values `CONTAINS` `DOES_NOT_CONTAIN` `DOES_NOT_EQUAL` `DOES_NOT_START_WITH` `EQUALS` `STARTS_WITH`
value	string	Value to compare to.

The `TagFilter` object

A tag-based filter of monitored entities.

Element Type Description

context

string

Element	Type	Description
context	string	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`
key	string	The key of the tag. Custom tags have the tag value here.
value	string	The value of the tag. Not applicable to custom tags. Can be `null`.

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

key

string

The key of the tag.

Custom tags have the tag value here.

value

string

The value of the tag.

Not applicable to custom tags.

Can be null.

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

shell
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

Disk events anomaly detection API - GET an event

Authentication

Parameters

Response

Response codes

Response body objects

The DiskEventAnomalyDetectionConfig object

The ConfigurationMetadata object

The DiskNameFilter object

The TagFilter object

Response body JSON model

Example

Curl

Request URL

Response body

Response code

The `DiskEventAnomalyDetectionConfig` object

The `ConfigurationMetadata` object

The `DiskNameFilter` object

The `TagFilter` object