Получение события v2: различия между версиями
ENetrebin (обсуждение | вклад) (Новая страница: «Получает все свойства указанного события. Запрос создает <code>application/json</code>полезную нагр...») |
ENetrebin (обсуждение | вклад) |
||
| Строка 7: | Строка 7: | ||
Этот запрос является выпуском Early Adopter и может быть изменен несовместимым образом. | Этот запрос является выпуском Early Adopter и может быть изменен несовместимым образом. | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan="3" | | | rowspan="3" |GET | ||
| | |Managed | ||
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/events/{eventId}</nowiki></code> | |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/events/{eventId}</nowiki></code> | ||
|- | |- | ||
| Строка 14: | Строка 14: | ||
|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/events/{eventId}</nowiki></code> | |<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/events/{eventId}</nowiki></code> | ||
|- | |- | ||
|Окружающая среда | |Окружающая среда АктивногоШлюза | ||
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/events/{eventId}</nowiki></code> | |<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/events/{eventId}</nowiki></code> | ||
|} | |} | ||
| Строка 26: | Строка 26: | ||
!Тип | !Тип | ||
!Описание | !Описание | ||
! | !In | ||
!Необходимый | !Необходимый | ||
|- | |- | ||
| | |eventId | ||
| | |string | ||
|ID требуемого события. | |ID требуемого события. | ||
| | |path | ||
|обязательный | |обязательный | ||
|} | |} | ||
| Строка 45: | Строка 45: | ||
|- | |- | ||
|200 | |200 | ||
| | |Event | ||
|Успех. Ответ содержит конфигурацию события. | |Успех. Ответ содержит конфигурацию события. | ||
|} | |} | ||
| Строка 58: | Строка 58: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |eventType | ||
| | |string | ||
|Тип события. | |Тип события. | ||
Может быть <code>null</code>. | Может быть <code>null</code>. | ||
|- | |- | ||
| | |entityId | ||
| | |EntityStub | ||
|Краткое представление отслеживаемого объекта. | |Краткое представление отслеживаемого объекта. | ||
Может быть <code>null</code>. | Может быть <code>null</code>. | ||
|- | |- | ||
| | |entityTags | ||
| | |METag[] | ||
|Список тегов связанного объекта. | |Список тегов связанного объекта. | ||
Может быть <code>null</code>. | Может быть <code>null</code>. | ||
|- | |- | ||
| | |underMaintenance | ||
| | |boolean | ||
|Если <code>true</code>, событие произошло, когда отслеживаемая система находилась на обслуживании. | |Если <code>true</code>, событие произошло, когда отслеживаемая система находилась на обслуживании. | ||
Может быть <code>null</code>. | Может быть <code>null</code>. | ||
|- | |- | ||
| | |suppressAlert | ||
| | |boolean | ||
|Состояние предупреждения во время технического обслуживания : | |Состояние предупреждения во время технического обслуживания : | ||
| Строка 91: | Строка 91: | ||
Может быть <code>null</code>. | Может быть <code>null</code>. | ||
|- | |- | ||
| | |suppressProblem | ||
| | |boolean | ||
|Статус обнаружения проблемы во время технического обслуживания : | |Статус обнаружения проблемы во время технического обслуживания : | ||
| Строка 100: | Строка 100: | ||
Может быть <code>null</code>. | Может быть <code>null</code>. | ||
|- | |- | ||
| | |frequentEvent | ||
| | |boolean | ||
|Если <code>true</code>, событие происходит часто . | |Если <code>true</code>, событие происходит часто . | ||
| Строка 108: | Строка 108: | ||
Может быть <code>null</code>. | Может быть <code>null</code>. | ||
|- | |- | ||
| | |managementZones | ||
| | |ManagementZone[] | ||
|Список всех зон управления, которым принадлежит событие. | |Список всех зон управления, которым принадлежит событие. | ||
Версия 09:45, 11 апреля 2022
Получает все свойства указанного события.
Запрос создает application/jsonполезную нагрузку.
Первых компаний, внедривших
Этот запрос является выпуском Early Adopter и может быть изменен несовместимым образом.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/events/{eventId}
|
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/events/{eventId}
| |
| Окружающая среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/events/{eventId}
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение событий ( events.read) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | In | Необходимый |
|---|---|---|---|---|
| eventId | string | ID требуемого события. | path | обязательный |
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 200 | Event | Успех. Ответ содержит конфигурацию события. |
Объекты тела ответа
Объект _ Event
Конфигурация события.
| Элемент | Тип | Описание |
|---|---|---|
| eventType | string | Тип события.
Может быть |
| entityId | EntityStub | Краткое представление отслеживаемого объекта.
Может быть |
| entityTags | METag[] | Список тегов связанного объекта.
Может быть |
| underMaintenance | boolean | Если true, событие произошло, когда отслеживаемая система находилась на обслуживании.
Может быть |
| suppressAlert | boolean | Состояние предупреждения во время технического обслуживания :
Может быть |
| suppressProblem | boolean | Статус обнаружения проблемы во время технического обслуживания :
Может быть |
| frequentEvent | boolean | Если true, событие происходит часто .
Частое событие не вызывает проблем. Может быть |
| managementZones | ManagementZone[] | Список всех зон управления, которым принадлежит событие.
Может быть |
| идентификатор события | нить | Идентификатор события.
Может быть |
| характеристики | Свойство события [] | Список свойств события.
Может быть |
| статус | нить | Статус события.
Элемент может содержать эти значения Может быть |
| время начала | целое число | Отметка времени возникновения события в миллисекундах UTC.
Может быть |
| время окончания | целое число | Отметка времени закрытия события в миллисекундах UTC.
Имеет значение, Может быть |
| заглавие | нить | Название события.
Может быть |
| идентификатор корреляции | нить | Идентификатор корреляции события.
Может быть |
Объект _ EntityStub
Краткое представление отслеживаемого объекта.
| Элемент | Тип | Описание |
|---|---|---|
| идентификатор объекта | Идентификатор объекта | Краткое представление отслеживаемого объекта.
Может быть |
| название | нить | Имя сущности.
Не включается в ответ, если сущность с соответствующим идентификатором не найдена. Может быть |
Объект _ EntityId
Краткое представление отслеживаемого объекта.
| Элемент | Тип | Описание |
|---|---|---|
| я бы | нить | Идентификатор сущности.
Может быть |
| тип | нить | Тип сущности.
Может быть |
Объект _ METag
Тег отслеживаемого объекта.
| Элемент | Тип | Описание |
|---|---|---|
| представление строки | нить | Строковое представление тега.
Может быть |
| ценность | нить | Значение тега.
Может быть |
| ключ | нить | Ключ тега.
Может быть |
| контекст | нить | Происхождение тега, например AWS или Cloud Foundry.
Пользовательские теги используют это Может быть |
Объект _ ManagementZone
Краткое представление зоны управления.
| Элемент | Тип | Описание |
|---|---|---|
| название | нить | Имя зоны управления.
Может быть |
| я бы | нить | Идентификатор зоны управления.
Может быть |
Объект _ EventProperty
Свойство события.
| Элемент | Тип | Описание |
|---|---|---|
| ценность | нить | Значение свойства события.
Может быть |
| ключ | нить | Ключ свойства события.
Может быть |
JSON-модель тела ответа
{
"eventType": "LOW_DISK_SPACE",
"entityId": {
"entityId": {
"id": "string",
"type": "string"
},
"name": "string"
},
"entityTags": [
{
"stringRepresentation": "string",
"value": "string",
"key": "string",
"context": "string"
}
],
"underMaintenance": true,
"suppressAlert": true,
"suppressProblem": true,
"frequentEvent": true,
"managementZones": [
{
"name": "string",
"id": "string"
}
],
"eventId": "4293884258445543163_1564039524182",
"properties": [
{
"value": "string",
"key": "string"
}
],
"status": "OPEN",
"startTime": 1564039524182,
"endTime": 1564039524182,
"title": "High CPU load on host X",
"correlationId": "933613657e1c8fcf"
}
Пример
В этом примере запрос запрашивает параметры события с идентификатором 6375436663535938547_1628496488654 .
Это событие SYNTHETIC_GLOBAL_OUTAGE , указывающее на глобальное отключение мониторов браузера.
Маркер API передается в заголовке авторизации .
Завиток
curl --request GET \
--url https://mySampleEnv.live.dynatrace.com/api/v2/events/6375436663535938547_1628496488654 \
--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL-адрес запроса
https://mySampleEnv.live.dynatrace.com/api/v2/events/6375436663535938547_1628496488654
Тело ответа
{
"eventId": "6375436663535938547_1628496488654",
"startTime": 1628496488654,
"endTime": 1628503679796,
"eventType": "SYNTHETIC_GLOBAL_OUTAGE",
"title": "Browser monitor global outage",
"entityId": {
"entityId": {
"id": "SYNTHETIC_TEST-03ABB7F6446D1727",
"type": "SYNTHETIC_TEST"
},
"name": "Maintenance window test"
},
"properties": [
{
"key": "dt.event.group_label",
"value": "Browser monitor global outage"
},
{
"key": "dt.event.is_rootcause_relevant",
"value": "true"
}
],
"status": "CLOSED",
"correlationId": "aecd1653df38ef50",
"entityTags": [
{
"context": "CONTEXTLESS",
"key": "Synthetic",
"value": "Browser",
"stringRepresentation": "Synthetic:Browser"
}
],
"managementZones": [
{
"id": "-7832237287622819191",
"name": "Synthetic tests"
}
],
"underMaintenance": true,
"suppressAlert": false,
"suppressProblem": false,
"frequentEvent": false
}
Код ответа
200