Metric events anomaly detection API - GET all events
Lists all existing metric event rules.
The request produces an application/json
payload.
This request is an early adopter release and may be changed in non compatible way.
GET |
|
Parameters
The request doesn't provide any configurable parameters.
Response format
The StubList object
An ordered list of short representations of DESK entities.
Element | Type | Description |
---|---|---|
values | EntityShortRepresentation[] | An ordered list of short representations of DESK entities. |
The EntityShortRepresentation object
The short representation of a DESK entity.
Element | Type | Description |
---|---|---|
id | string | The ID of the DESK entity. |
name | string | The name of the DESK entity. |
description | string | A short description of the DESK entity. |
{
"values": [
{
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "DESK entity 1",
"description": "DESK entity 1 for the REST API example\n"
},
{
"id": "ee70f7d3-9a4e-4f5f-94d2-c9d6156f1618",
"name": "DESK entity 2"
},
{
"id": "8cdabe77-9e1a-4be8-b3df-269dd6fa9d7f"
}
]
}
Example
In this example, the request lists all custom metric event rules of the environment. The response includes events associated with certain entities.
The API token is passed in the Authorization header.
The result is truncated to four entries.
Curl
curl -X GET \
https://mySampleEnv.live.dexp.ae/api/config/v1/anomalyDetection/metricEvents?includeEntityFilterMetricEvents=true \
-H 'Authorization: Api-token abcdefjhij1234567890'
Request URL
https://mySampleEnv.live.dexp.ae/api/config/v1/anomalyDetection/metricEvents?includeEntityFilterMetricEvents=true
Response body
{
"values": [
{
"id": "ruxit.perfmon.dotnetV4:%TimeInGC:time_in_gc_alert_high_generic",
"name": "High GC time",
"description": "The .NET GC time of {severity} is {alert_condition} the threshold of {threshold}"
},
{
"id": "custom.jmx.hornetq:Queue.MessageCount:jmx_alert",
"name": "Low message count",
"description": "Actual number of {severity} queue messages is {alert_condition} the critical threshold of {threshold}"
},
{
"id": "DESK.remote.python.elasticsearch:node.os.cpu_percent:node.os.cpu_percent.high_usage",
"name": "High OS CPU usage",
"description": "The OS CPU usage is {alert_condition} the threshold of {threshold}"
},
{
"id": "d828b647-7f9a-4664-8401-d59fcb55bd3e",
"name": "cpu alert",
"description": "The {metricname} value of {severity} was {alert_condition} your custom threshold of {threshold}."
}
]
}
Response code
200