Disk events anomaly detection API - GET an event
Gets the parameters of the specified disk event rule.
The request produces an application/json payload.
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 Read configuration (ReadConfig) permission assigned to your API token. 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 | optional |
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | Disk | Success |
Response body objects
The DiskEventAnomalyDetectionConfig object
| Element | Type | Description | Required |
|---|---|---|---|
| metadata | Configuration | Metadata useful for debugging | optional |
| id | string | The ID of the disk event rule. | optional |
| name | string | The name of the disk event rule. | required |
| enabled | boolean | Disk event rule enabled/disabled. | required |
| metric | string | The metric to monitor. | required |
| threshold | number | The threshold to trigger disk event.
| required |
| samples | integer | The number of samples to evaluate. | required |
| violatingSamples | integer | The number of samples that must violate the threshold to trigger an event. Must not exceed the number of evaluated samples. | required |
| diskNameFilter | Disk | Narrows the rule usage down to disks, matching the specified criteria. | optional |
| tagFilters | Tag | Narrows the rule usage down to the hosts matching the specified tags. | optional |
| hostGroupId | string | Narrows the rule usage down to disks that run on hosts that themselves run on the specified host group. | optional |
The ConfigurationMetadata object
Metadata useful for debugging
| Element | Type | Description | Required |
|---|---|---|---|
| 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 |
| clusterVersion | string | Dynatrace version. | optional |
The DiskNameFilter object
Narrows the rule usage down to disks, matching the specified criteria.
| Element | Type | Description | Required |
|---|---|---|---|
| operator | string | Comparison operator. | required |
| value | string | Value to compare to. | required |
The TagFilter object
A tag-based filter of monitored entities.
| Element | Type | Description | Required |
|---|---|---|---|
| context | string | The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the | required |
| key | string | The key of the tag. Custom tags have the tag value here. | required |
| value | string | The value of the tag. Not applicable to custom tags. | optional |
Response body JSON model
{
"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:
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-a5f0e8e19fd0Response 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