Получение события v2 - История изменений

ENetrebin в 16:05, 20 февраля 2023

2023-02-20T16:05:09Z

← Предыдущая		Версия 16:05, 20 февраля 2023
Строка 7:		Строка 7:
	Этот запрос является выпуском Early Adopter и может быть изменен несовместимым образом.		Этот запрос является выпуском Early Adopter и может быть изменен несовместимым образом.
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="3" \|GET		\| rowspan="2" \|GET
	\|Managed		\|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>
	\|-		\|-
	\|~~SaaS~~		\|Среда АктивногоШлюза
	~~\|<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>
	\|}		\|}
Строка 328:		Строка 325:
	==== Curl ====		==== 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.ruscomtech.ru/api/v2/events/6375436663535938547_1628496488654</nowiki> \
	--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>		--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>

	==== URL-адрес запроса ====		==== URL-адрес запроса ====
	<code><nowiki>https://mySampleEnv.live.~~dynatrace~~.~~com~~/api/v2/events/6375436663535938547_1628496488654</nowiki></code>		<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events/6375436663535938547_1628496488654</nowiki></code>

	==== Тело ответа ====		==== Тело ответа ====

ENetrebin в 06:35, 12 августа 2022

2022-08-12T06:35:25Z

← Предыдущая		Версия 06:35, 12 августа 2022
Строка 1:		Строка 1:
	Получает все свойства указанного события.		Получает все свойства указанного события.

	Запрос создает <code>application/json</code>полезную нагрузку.		Запрос создает <code>application/json</code>полезную нагрузку.

	Первых компаний, внедривших		Первых компаний, внедривших

ENetrebin: /* Объект _ ManagementZone */

2022-04-13T08:13:42Z

Объект _ ManagementZone

← Предыдущая		Версия 08:13, 13 апреля 2022
Строка 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> \

ENetrebin: /* Объект _ EntityStub */

2022-04-13T08:08:48Z

Объект _ EntityStub

← Предыдущая		Версия 08:08, 13 апреля 2022
Строка 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.

ENetrebin: /* Объект _ Event */

2022-04-13T07:38:04Z

Объект _ Event

← Предыдущая		Версия 07:38, 13 апреля 2022
Строка 114:		Строка 114:
	Может быть <code>null</code>.		Может быть <code>null</code>.
	\|-		\|-
	\|~~идентификатор события~~		\|eventId
	\|string		\|string
	\|Идентификатор события.		\|Идентификатор события.
Строка 120:		Строка 120:
	Может быть <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
	\|Идентификатор корреляции события.		\|Идентификатор корреляции события.

ENetrebin в 08:20, 12 апреля 2022

2022-04-12T08:20:17Z

← Предыдущая		Версия 08:20, 12 апреля 2022
Строка 115:		Строка 115:
	\|-		\|-
	\|идентификатор события		\|идентификатор события
	\|~~нить~~		\|string
	\|Идентификатор события.		\|Идентификатор события.

ENetrebin в 09:45, 11 апреля 2022

2022-04-11T09:45:26Z

← Предыдущая		Версия 09:45, 11 апреля 2022
Строка 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>
	\|-		\|-
	\|Окружающая среда ~~ActiveGate~~		\|Окружающая среда АктивногоШлюза
	\|<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[]
	\|Список всех зон управления, которым принадлежит событие.		\|Список всех зон управления, которым принадлежит событие.

ENetrebin: Новая страница: «Получает все свойства указанного события. Запрос создает `application/json`полезную нагр...»

2022-04-11T08:20:36Z

Новая страница: «Получает все свойства указанного события. Запрос создает <code>application/json</code>полезную нагр...»

Новая страница

Получает все свойства указанного события.

Запрос создает <code>application/json</code>полезную нагрузку.

Первых компаний, внедривших

Этот запрос является выпуском Early Adopter и может быть изменен несовместимым образом.
{| class="wikitable"
| rowspan="3" |ПОЛУЧИТЬ
|Удалось
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/events/{eventId}</nowiki></code>
|-
|SaaS
|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/events/{eventId}</nowiki></code>
|-
|Окружающая среда ActiveGate
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/events/{eventId}</nowiki></code>
|}

== Аутентификация ==
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение событий ( <code>events.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!В
!Необходимый
|-
|идентификатор события
|нить
|ID требуемого события.
|дорожка
|обязательный
|}

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|Мероприятие
|Успех. Ответ содержит конфигурацию события.
|}

=== Объекты тела ответа ===

==== Объект _ <code>Event</code> ====
Конфигурация события.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|тип события
|нить
|Тип события.

Может быть <code>null</code>.
|-
|идентификатор объекта
|Заглушка сущности
|Краткое представление отслеживаемого объекта.

Может быть <code>null</code>.
|-
|сущностьТеги
|М Е тег []
|Список тегов связанного объекта.

Может быть <code>null</code>.
|-
|на техобслуживании
|логический
|Если <code>true</code>, событие произошло, когда отслеживаемая система находилась на обслуживании.

Может быть <code>null</code>.
|-
|подавлять оповещение
|логический
|Состояние предупреждения во время технического обслуживания :

* <code>false</code>: Оповещение работает как обычно.
* <code>true</code>: Оповещение отключено.

Может быть <code>null</code>.
|-
|подавлятьпроблему
|логический
|Статус обнаружения проблемы во время технического обслуживания :

* <code>false</code>: Обнаружение проблем работает как обычно.
* <code>true</code>: обнаружение проблем отключено.

Может быть <code>null</code>.
|-
|частособытие
|логический
|Если <code>true</code>, событие происходит часто .

Частое событие не вызывает проблем.

Может быть <code>null</code>.
|-
|управлениеЗоны
|Зона управления []
|Список всех зон управления, которым принадлежит событие.

Может быть <code>null</code>.
|-
|идентификатор события
|нить
|Идентификатор события.

Может быть <code>null</code>.
|-
|характеристики
|Свойство события []
|Список свойств события.

Может быть <code>null</code>.
|-
|статус
|нить
|Статус события.

Элемент может содержать эти значения

Может быть <code>null</code>.
|-
|время начала
|целое число
|Отметка времени возникновения события в миллисекундах UTC.

Может быть <code>null</code>.
|-
|время окончания
|целое число
|Отметка времени закрытия события в миллисекундах UTC.

Имеет значение, <code>null</code>если событие все еще активно.

Может быть <code>null</code>.
|-
|заглавие
|нить
|Название события.

Может быть <code>null</code>.
|-
|идентификатор корреляции
|нить
|Идентификатор корреляции события.

Может быть <code>null</code>.
|}

==== Объект _ <code>EntityStub</code> ====
Краткое представление отслеживаемого объекта.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|идентификатор объекта
|Идентификатор объекта
|Краткое представление отслеживаемого объекта.

Может быть <code>null</code>.
|-
|название
|нить
|Имя сущности.

Не включается в ответ, если сущность с соответствующим идентификатором не найдена.

Может быть <code>null</code>.
|}

==== Объект _ <code>EntityId</code> ====
Краткое представление отслеживаемого объекта.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|я бы
|нить
|Идентификатор сущности.

Может быть <code>null</code>.
|-
|тип
|нить
|Тип сущности.

Может быть <code>null</code>.
|}

==== Объект _ <code>METag</code> ====
Тег отслеживаемого объекта.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|представление строки
|нить
|Строковое представление тега.

Может быть <code>null</code>.
|-
|ценность
|нить
|Значение тега.

Может быть <code>null</code>.
|-
|ключ
|нить
|Ключ тега.

Может быть <code>null</code>.
|-
|контекст
|нить
|Происхождение тега, например AWS или Cloud Foundry.

Пользовательские теги используют это <code>CONTEXTLESS</code>значение.

Может быть <code>null</code>.
|}

==== Объект _ <code>ManagementZone</code> ====
Краткое представление зоны управления.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|название
|нить
|Имя зоны управления.

Может быть <code>null</code>.
|-
|я бы
|нить
|Идентификатор зоны управления.

Может быть <code>null</code>.
|}

==== Объект _ <code>EventProperty</code> ====
Свойство события.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|ценность
|нить
|Значение свойства события.

Может быть <code>null</code>.
|-
|ключ
|нить
|Ключ свойства события.

Может быть <code>null</code>.
|}

=== JSON-модель тела ответа ===
<code>{
"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"
}</code>

== Пример ==
В этом примере запрос запрашивает параметры события с идентификатором 6375436663535938547_1628496488654 .

Это событие SYNTHETIC_GLOBAL_OUTAGE , указывающее на глобальное отключение мониторов браузера.

Маркер API передается в заголовке авторизации .

==== Завиток ====
<code>curl --request GET \
--url <nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/events/6375436663535938547_1628496488654</nowiki> \
--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>

==== URL-адрес запроса ====
<code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/events/6375436663535938547_1628496488654</nowiki></code>

==== Тело ответа ====
<code>{
"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
}</code>

==== Код ответа ====
200