Получение ленты событий
Материал из Документация Ключ-АСТРОМ
Версия от 08:17, 14 марта 2022; ENetrebin (обсуждение | вклад) (Новая страница: «Список всех событий вашей среды и их параметров. Поскольку возможное количество событий...»)
Список всех событий вашей среды и их параметров. Поскольку возможное количество событий может быть большим, ответ ограничен 150 событиями. Вы можете сузить вывод, указав параметры фильтрации в своем запросе.
Запрос создает application/jsonполезную нагрузку.
| ПОЛУЧАТЬ | Удалось | https://{your-domain}/e/{your-environment-id}/api/v1/events
|
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v1/events
| |
| Окружающая среда ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v1/events
|
Аутентификация
Чтобы выполнить этот запрос, вам необходимо разрешение на проблему с доступом и канал событий, метрики и топологию ( DataExport) , назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | В | Необходимый |
|---|---|---|---|---|
| от | целое число | Отметка времени начала запроса в миллисекундах UTC.
Если не задано, используется 30 дней назад, если не задано значение relativeTime . |
запрос | необязательный |
| к | целое число | Конечная метка времени запроса в миллисекундах UTC.
Если не задано, используется текущая временная метка, если не задано значение relativeTime . Срок не должен превышать 2 лет. |
запрос | необязательный |
| относительное время | нить | Относительный таймфрейм, назад от текущего времени.
Элемент может содержать эти значения
|
запрос | необязательный |
| тип события | нить | Фильтрует результирующий набор событий по типу события.
Элемент может содержать эти значения
|
запрос | необязательный |
| идентификатор объекта | нить | Фильтрует результирующий набор событий до событий, связанных с указанным объектом Dynatrace. | запрос | необязательный |
| курсор | нить | Ответ ограничен 150 событиями, поэтому, если вы хотите получить больше, вы можете использовать курсор, чтобы получить следующие 150. Этот параметр должен быть пустым при первом запросе.
Клавиша курсора затем может быть найдена в поле nextCursor предыдущего ответа. При использовании строки курсора нет необходимости указывать дополнительные параметры, так как эта информация уже закодирована внутри курсора. |
запрос | необязательный |
Ответ
Каждое событие содержит как минимум следующие элементы метаинформации и свойства, относящиеся к событию.
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 200 | Результат запроса события | Успех |
Объекты тела ответа
Объект _ EventQueryResult
События окружающей среды.
| Элемент | Тип | Описание |
|---|---|---|
| следующийКурсор | нить | Курсор для следующих 150 событий, соответствующих указанным критериям.
Установите это значение для параметра запроса курсора . Без него вы снова получите первые 150 событий. Никаких дополнительных параметров указывать не нужно, так как курсор уже содержит их все. Может быть |
| от | целое число | Начало периода запроса.
Может быть |
| к | целое число | Конец периода запроса.
Может быть |
| общее количество событий | целое число | Общее количество событий, соответствующих заданным критериям.
Может быть |
| Мероприятия | Запись на отдых [ ] | Список событий.
Может быть |
Объект _ EventRestEntry
Набор параметров события.
Помимо общих свойств, упомянутых здесь, которые есть у каждого события, фактическое событие имеет набор метаданных, которые различаются в зависимости от типа события.
| Элемент | Тип | Описание |
|---|---|---|
| время начала | целое число | Отметка времени обнаружения события в миллисекундах UTC.
Может быть |
| время окончания | целое число | Отметка времени закрытия события в миллисекундах UTC.
Может быть |
| идентификатор объекта | нить | Идентификатор затронутого объекта Dynatrace.
Может быть |
| имя сущности | нить | Имя затронутого объекта Dynatrace.
Может быть |
| Уровень опасности | нить | Тяжесть события.
Элемент может содержать эти значения
Может быть |
| уровень воздействия | нить | Уровень воздействия события. Он показывает, на что влияет проблема: на инфраструктуру, службу или приложение.
Элемент может содержать эти значения
Может быть |
| тип события | нить | Тип события.
Элемент может содержать эти значения
Может быть |
| идентификатор ресурса | нить | Идентификатор ресурса, на котором произошло событие.
Может быть |
| имя_ресурса | нить | Имя ресурса, на котором произошло событие.
Может быть |
| состояние события | нить | Состояние мероприятия: открытое или закрытое.
Элемент может содержать эти значения
Может быть |
| теги | Информация о теге [] | Теги объекта Dynatrace, вызвавшего событие.
Может быть |
| я бы | нить | Закодированный идентификатор события. Формат — eventID_startTime .
Вы должны использовать значение из этого поля, когда вам нужен идентификатор события. Может быть |
Объект _ TagInfo
Тег сущности Dynatrace.
| Элемент | Тип | Описание |
|---|---|---|
| контекст | нить | Происхождение тега, например AWS или Cloud Foundry.
Пользовательские теги используют это Элемент может содержать эти значения
|
| ключ | нить | Ключ тега.
Пользовательские теги имеют значение тега здесь. |
| стоимость | нить | Значение тега.
Не применимо к пользовательским тегам. Может быть |
JSON-модель тела ответа
{
"nextCursor": "AgEBAAFn5IIFrgEAAAFofwDTrgAAAQAcMTY4N2RhYzViZTAtZmUxODEwOWQ5YTA1MTIyNQ%3D%3D",
"from": 1521042929000,
"to": 1521542929000,
"totalEventCount": 2,
"events": [
{
"startTime": 1521042929000,
"endTime": 1521542929000,
"entityId": "HOST-0000000000000007",
"entityName": "Example Host",
"severityLevel": "PERFORMANCE",
"impactLevel": "INFRASTRUCTURE",
"eventType": "SLOW_DISK",
"eventStatus": "OPEN",
"tags": [
{
"context": "CONTEXTLESS",
"key": "exampleTag"
}
],
"id": "5915682011263205071_1521042929000",
"source": "builtin"
},
{
"startTime": 1521042929000,
"endTime": 1521542929000,
"entityId": "HOST-0000000000000007",
"entityName": "Example Host",
"severityLevel": "PERFORMANCE",
"impactLevel": "INFRASTRUCTURE",
"eventType": "SLOW_DISK",
"eventStatus": "OPEN",
"tags": [
{
"context": "CONTEXTLESS",
"key": "exampleTag"
}
],
"id": "5915682011263205071_1521042929000",
"source": "builtin"
}
]
}
Пример
В этом примере запрос запрашивает все события ERROR_EVENT , произошедшие за последние 24 часа . Результат усекается до двух событий.
Маркер API передается в заголовке авторизации .
Завиток
curl -X GET \
'https://mySampleEnv.live.dynatrace.com/api/v1/events?eventType=ERROR_EVENT&relativeTime=day' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL-адрес запроса
https://mySampleEnv.live.dynatrace.com/api/v1/events?eventType=ERROR_EVENT&relativeTime=day
Содержание ответа
{
"nextEventStartTms": null,
"nextEventId": null,
"nextCursor": null,
"from": 1530703635653,
"to": 1533295635653,
"totalEventCount": 25,
"events": [
{
"eventId": -8338439733889003014,
"startTime": 1532328338475,
"endTime": 1532328638475,
"entityId": "HOST-E4D1E5F46E239F21",
"entityName": "l-8.dyna.trace",
"severityLevel": "ERROR",
"impactLevel": "INFRASTRUCTURE",
"eventType": "ERROR_EVENT",
"eventStatus": "CLOSED",
"tags": [
{
"context": "CONTEXTLESS",
"key": "deploy"
},
{
"context": "CONTEXTLESS",
"key": "room23"
}
],
"id": "-8338439733889003014_1532328338475",
"annotationDescription": "testTrigger",
"correlationId": "67da0a4293956e55",
"source": "restTest"
},
{
"eventId": 3092227520312561338,
"startTime": 1531832640600,
"endTime": 1531836240600,
"entityId": "HOST-CE6A2253598EA88D",
"entityName": "q2.docker.l5",
"severityLevel": "ERROR",
"impactLevel": "INFRASTRUCTURE",
"eventType": "ERROR_EVENT",
"eventStatus": "CLOSED",
"tags": [
{
"context": "CONTEXTLESS",
"key": "ServiceNow"
}
],
"id": "3092227520312561338_1531832640600",
"customProperties": {
"Property 2": "value 2",
"Property 1": "value 1",
"Property 3": "value 3"
},
"annotationDescription": "package is damaged",
"correlationId": "1b79973c6902b486",
"source": "myAPI"
}
]
}
Код ответа
200
