Список всех существующих правил событий метрик.
Запрос создает в качестве полезной нагрузки application/json формат.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/metricEvents
|
| Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/metricEvents
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение конфигурации ( ReadConfig) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
Запрос не предоставляет никаких настраиваемых параметров.
Параметры
| Параметр | Тип | Описание | In | Необходимость |
|---|---|---|---|---|
| includeEntityFilterMetricEvents | boolean | Отметьте, чтобы включить в ответ события метрик со связанными объектами.
События метрик с фильтрами сущностей несовместимы в разных средах. Если установлено значение |
query | по желанию |
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 200 | StubList | Успех |
Объекты тела ответа
Объект StubList
Упорядоченный список кратких представлений объектов Ключ-АСТРОМ.
| Элемент | Тип | Описание |
|---|---|---|
| values | EntityShortRepresentation[] | Упорядоченный список кратких представлений объектов Ключ-АСТРОМ. |
Объект EntityShortRepresentation
Краткое представление объекта Ключ-АСТРОМ.
| Элемент | Тип | Описание |
|---|---|---|
| id | string | Идентификатор объекта Ключ-АСТРОМ. |
| name | string | Имя объекта Ключ-АСТРОМ. |
| description | string | Краткое описание объекта Ключ-АСТРОМ. |
JSON-модель тела ответа
{
"values": [
{
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "Astromkey entity 1",
"description": "Astromkey entity 1 for the REST API example"
},
{
"id": "ee70f7d3-9a4e-4f5f-94d2-c9d6156f1618",
"name": "Astromkey entity 2"
},
{
"id": "8cdabe77-9e1a-4be8-b3df-269dd6fa9d7f"
}
]
}
Пример
В этом примере в запросе перечислены все настраиваемые правила событий метрик среды. Ответ включает события, связанные с определенными объектами.
Маркер API передается в заголовке авторизации .
Результат усекается до четырех записей.
Curl
curl -X GET \
https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/metricEvents?includeEntityFilterMetricEvents=true \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL-адрес запроса
https://mySampleEnv.live.ruscomtech.ru/api/config/v1/anomalyDetection/metricEvents?includeEntityFilterMetricEvents=true
Тело ответа
{
"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": "astromkey.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}."
}
]
}
Код ответа
200