Получение события v2: различия между версиями
ENetrebin (обсуждение | вклад) |
ENetrebin (обсуждение | вклад) |
||
(не показаны 4 промежуточные версии этого же участника) | |||
Строка 1: | Строка 1: | ||
Получает все свойства указанного события. | Получает все свойства указанного события. | ||
Запрос создает <code>application/json</code>полезную нагрузку. | Запрос создает <code>application/json</code>полезную нагрузку. | ||
Первых компаний, внедривших | Первых компаний, внедривших | ||
Строка 114: | Строка 114: | ||
Может быть <code>null</code>. | Может быть <code>null</code>. | ||
|- | |- | ||
| | |eventId | ||
| | |string | ||
|Идентификатор события. | |Идентификатор события. | ||
Может быть <code>null</code>. | Может быть <code>null</code>. | ||
|- | |- | ||
| | |properties | ||
| | |EventProperty[] | ||
|Список свойств события. | |Список свойств события. | ||
Строка 127: | Строка 127: | ||
|- | |- | ||
|статус | |статус | ||
| | |string | ||
|Статус события. | |Статус события. | ||
Строка 134: | Строка 134: | ||
Может быть <code>null</code>. | Может быть <code>null</code>. | ||
|- | |- | ||
| | |startTime | ||
| | |integer | ||
|Отметка времени возникновения события в миллисекундах UTC. | |Отметка времени возникновения события в миллисекундах UTC. | ||
Может быть <code>null</code>. | Может быть <code>null</code>. | ||
|- | |- | ||
| | |endTime | ||
| | |integer | ||
|Отметка времени закрытия события в миллисекундах UTC. | |Отметка времени закрытия события в миллисекундах UTC. | ||
Строка 148: | Строка 148: | ||
Может быть <code>null</code>. | Может быть <code>null</code>. | ||
|- | |- | ||
| | |title | ||
| | |string | ||
|Название события. | |Название события. | ||
Может быть <code>null</code>. | Может быть <code>null</code>. | ||
|- | |- | ||
| | |correlationId | ||
| | |string | ||
|Идентификатор корреляции события. | |Идентификатор корреляции события. | ||
Строка 168: | Строка 168: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |entityId | ||
| | |EntityId | ||
|Краткое представление отслеживаемого объекта. | |Краткое представление отслеживаемого объекта. | ||
Может быть <code>null</code>. | Может быть <code>null</code>. | ||
|- | |- | ||
| | |name | ||
| | |string | ||
|Имя сущности. | |Имя сущности. | ||
Строка 190: | Строка 190: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |id | ||
| | |string | ||
|Идентификатор сущности. | |Идентификатор сущности. | ||
Может быть <code>null</code>. | Может быть <code>null</code>. | ||
|- | |- | ||
| | |type | ||
| | |string | ||
|Тип сущности. | |Тип сущности. | ||
Строка 210: | Строка 210: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |stringRepresentation | ||
| | |string | ||
|Строковое представление тега. | |Строковое представление тега. | ||
Может быть <code>null</code>. | Может быть <code>null</code>. | ||
|- | |- | ||
| | |value | ||
| | |string | ||
|Значение тега. | |Значение тега. | ||
Может быть <code>null</code>. | Может быть <code>null</code>. | ||
|- | |- | ||
| | |key | ||
| | |string | ||
|Ключ тега. | |Ключ тега. | ||
Может быть <code>null</code>. | Может быть <code>null</code>. | ||
|- | |- | ||
| | |context | ||
| | |string | ||
|Происхождение тега, например AWS или Cloud Foundry. | |Происхождение тега, например AWS или Cloud Foundry. | ||
Строка 244: | Строка 244: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |name | ||
| | |string | ||
|Имя зоны управления. | |Имя зоны управления. | ||
Может быть <code>null</code>. | Может быть <code>null</code>. | ||
|- | |- | ||
| | |id | ||
| | |string | ||
|Идентификатор зоны управления. | |Идентификатор зоны управления. | ||
Строка 264: | Строка 264: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |value | ||
| | |string | ||
|Значение свойства события. | |Значение свойства события. | ||
Может быть <code>null</code>. | Может быть <code>null</code>. | ||
|- | |- | ||
| | |key | ||
| | |string | ||
|Ключ свойства события. | |Ключ свойства события. | ||
Строка 326: | Строка 326: | ||
Маркер API передается в заголовке авторизации . | Маркер API передается в заголовке авторизации . | ||
==== | ==== Curl ==== | ||
<code>curl --request GET \ | <code>curl --request GET \ | ||
--url <nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/events/6375436663535938547_1628496488654</nowiki> \ | --url <nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/events/6375436663535938547_1628496488654</nowiki> \ |
Текущая версия на 06:35, 12 августа 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[] | Список всех зон управления, которым принадлежит событие.
Может быть |
eventId | string | Идентификатор события.
Может быть |
properties | EventProperty[] | Список свойств события.
Может быть |
статус | string | Статус события.
Элемент может содержать эти значения Может быть |
startTime | integer | Отметка времени возникновения события в миллисекундах UTC.
Может быть |
endTime | integer | Отметка времени закрытия события в миллисекундах UTC.
Имеет значение, Может быть |
title | string | Название события.
Может быть |
correlationId | string | Идентификатор корреляции события.
Может быть |
Объект _ EntityStub
Краткое представление отслеживаемого объекта.
Элемент | Тип | Описание |
---|---|---|
entityId | EntityId | Краткое представление отслеживаемого объекта.
Может быть |
name | string | Имя сущности.
Не включается в ответ, если сущность с соответствующим идентификатором не найдена. Может быть |
Объект _ EntityId
Краткое представление отслеживаемого объекта.
Элемент | Тип | Описание |
---|---|---|
id | string | Идентификатор сущности.
Может быть |
type | string | Тип сущности.
Может быть |
Объект _ METag
Тег отслеживаемого объекта.
Элемент | Тип | Описание |
---|---|---|
stringRepresentation | string | Строковое представление тега.
Может быть |
value | string | Значение тега.
Может быть |
key | string | Ключ тега.
Может быть |
context | string | Происхождение тега, например AWS или Cloud Foundry.
Пользовательские теги используют это Может быть |
Объект _ ManagementZone
Краткое представление зоны управления.
Элемент | Тип | Описание |
---|---|---|
name | string | Имя зоны управления.
Может быть |
id | string | Идентификатор зоны управления.
Может быть |
Объект _ EventProperty
Свойство события.
Элемент | Тип | Описание |
---|---|---|
value | string | Значение свойства события.
Может быть |
key | string | Ключ свойства события.
Может быть |
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
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