GET события v2 - История изменений

IKuznetsov в 14:18, 24 декабря 2024

2024-12-24T14:18:43Z

← Предыдущая версия		Версия от 14:18, 24 декабря 2024
Строка 1:		Строка 1:
	'''''[[API АппОптима]] / [[API АппОптима\|Эндпойнты среды]] / [~~[API АппОптима~~#:~:text=DELETE ~~тегов~~-,~~Развёртывание~~,-~~править\|~~Развёртывание]] / [~~[API АппОптима~~#:~:text=~~развертывания из Jenkins~~-,~~События v2~~,-GET ~~списка событий\|~~События v2]] / GET события v2'''''		'''''[[API АппОптима]] / [[API АппОптима\|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D1%80%D0%B0%D0%B7%D0%B2%D0%B5%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D1%8F%20%D0%B8%D0%B7%20Jenkins-,%D0%A1%D0%BE%D0%B1%D1%8B%D1%82%D0%B8%D1%8F%20v2,-GET%20%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B0%20%D1%81%D0%BE%D0%B1%D1%8B%D1%82%D0%B8%D0%B9 События v2] / GET события v2'''''

	Получает все свойства указанного события.		Получает все свойства указанного события.
Строка 275:		Строка 275:
	"title": "High CPU load on host X",		"title": "High CPU load on host X",
	"correlationId": "933613657e1c8fcf"		"correlationId": "933613657e1c8fcf"
	}~~</code>~~		}
	==Пример==		==Пример==
	В этом примере запрос запрашивает параметры события с идентификатором 6375436663535938547_1628496488654 .		В этом примере запрос запрашивает параметры события с идентификатором 6375436663535938547_1628496488654 .
Строка 285:		Строка 285:
	<curl --request GET \		<curl --request GET \
	--url <nowiki>https://mySampleEnv.live.ruscomtech.ru/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'
	====URL-адрес запроса====		====URL-адрес запроса====
	<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events/6375436663535938547_1628496488654</nowiki></code>		<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events/6375436663535938547_1628496488654</nowiki></code>
Строка 332:		Строка 332:
	"suppressProblem": false,		"suppressProblem": false,
	"frequentEvent": false		"frequentEvent": false
	}~~</code>~~		}
	====Код ответа====		====Код ответа====
	200		200

IKuznetsov в 12:39, 24 декабря 2024

2024-12-24T12:39:32Z

← Предыдущая версия		Версия от 12:39, 24 декабря 2024
Строка 1:		Строка 1:
	'''''[[API ~~Ключ-АСТРОМ~~]] / [[API ~~Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B~~\|Эндпойнты среды]] / [[API ~~Ключ~~-~~АСТРОМ#.D0.A0.D0.B0.D0.B7.D0.B2.D1.91.D1.80.D1.82.D1.8B.D0.B2.D0.B0.D0.BD.D0.B8.D0.B5~~\|Развёртывание]] / События v2 / GET события v2'''''		'''''[[API АппОптима]] / [[API АппОптима\|Эндпойнты среды]] / [[API АппОптима#:~:text=DELETE тегов-,Развёртывание,-править\|Развёртывание]] / [[API АппОптима#:~:text=развертывания из Jenkins-,События v2,-GET списка событий\|События v2]] / GET события v2'''''

	Получает все свойства указанного события.		Получает все свойства указанного события.
Строка 10:		Строка 10:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|GET		\| rowspan="2" \|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>
	\|-		\|-
Строка 236:		Строка 236:
	\|}		\|}
	===JSON-модель тела ответа===		===JSON-модель тела ответа===
	<~~code>~~{		<{
	"eventType": "LOW_DISK_SPACE",		"eventType": "LOW_DISK_SPACE",
	"entityId": {		"entityId": {
Строка 283:		Строка 283:
	Маркер API передается в заголовке авторизации .		Маркер API передается в заголовке авторизации .
	====Curl====		====Curl====
	<~~code>~~curl --request GET \		<curl --request GET \
	--url <nowiki>https://mySampleEnv.live.ruscomtech.ru/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>
Строка 289:		Строка 289:
	<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events/6375436663535938547_1628496488654</nowiki></code>		<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events/6375436663535938547_1628496488654</nowiki></code>
	====Тело ответа====		====Тело ответа====
	<~~code>~~{		<{
	"eventId": "6375436663535938547_1628496488654",		"eventId": "6375436663535938547_1628496488654",
	"startTime": 1628496488654,		"startTime": 1628496488654,

ENetrebin в 16:25, 11 июня 2024

2024-06-11T16:25:19Z

← Предыдущая версия		Версия от 16:25, 11 июня 2024
Строка 44:		Строка 44:
	\|}		\|}
	===Объекты тела ответа===		===Объекты тела ответа===
	====Объект _ <code>Event</code>====		====Объект <code>Event</code>====
	Конфигурация события.		Конфигурация события.
	{\| class="wikitable"		{\| class="wikitable"
Строка 136:		Строка 136:
	Может быть <code>null</code>.		Может быть <code>null</code>.
	\|}		\|}
	====Объект _ <code>EntityStub</code>====		====Объект <code>EntityStub</code>====
	Краткое представление отслеживаемого объекта.		Краткое представление отслеживаемого объекта.
	{\| class="wikitable"		{\| class="wikitable"
Строка 155:		Строка 155:
	Может быть <code>null</code>.		Может быть <code>null</code>.
	\|}		\|}
	====Объект _ <code>EntityId</code>====		====Объект <code>EntityId</code>====
	Краткое представление отслеживаемого объекта.		Краткое представление отслеживаемого объекта.
	{\| class="wikitable"		{\| class="wikitable"
Строка 172:		Строка 172:
	Может быть <code>null</code>.		Может быть <code>null</code>.
	\|}		\|}
	====Объект _ <code>METag</code>====		====Объект <code>METag</code>====
	Тег отслеживаемого объекта.		Тег отслеживаемого объекта.
	{\| class="wikitable"		{\| class="wikitable"
Строка 201:		Строка 201:
	Может быть <code>null</code>.		Может быть <code>null</code>.
	\|}		\|}
	====Объект _ <code>ManagementZone</code>====		====Объект <code>ManagementZone</code>====
	Краткое представление зоны управления.		Краткое представление зоны управления.
	{\| class="wikitable"		{\| class="wikitable"
Строка 218:		Строка 218:
	Может быть <code>null</code>.		Может быть <code>null</code>.
	\|}		\|}
	====Объект _ <code>EventProperty</code>====		====Объект <code>EventProperty</code>====
	Свойство события.		Свойство события.
	{\| class="wikitable"		{\| class="wikitable"

ENetrebin: Новая страница: «'''''API Ключ-АСТРОМ / API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B|Эндп...»

2024-06-11T16:23:20Z

Новая страница: «'''''API Ключ-АСТРОМ / API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B|Эндп...»

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

'''''[[API Ключ-АСТРОМ]] / [[API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B|Эндпойнты среды]] / [[API Ключ-АСТРОМ#.D0.A0.D0.B0.D0.B7.D0.B2.D1.91.D1.80.D1.82.D1.8B.D0.B2.D0.B0.D0.BD.D0.B8.D0.B5|Развёртывание]] / События v2 / GET события v2'''''

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

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

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

Этот запрос является выпуском Early Adopter и может быть изменен несовместимым образом.
{| class="wikitable"
| rowspan="2" |GET
|Managed
|<code><nowiki>https://{your-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>
|}
==Аутентификация==
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение событий ( <code>events.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
==Параметры==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимый
|-
|eventId
|string
|ID требуемого события.
|path
|обязательный
|}
==Ответ==
===Коды ответов===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|Event
|Успех. Ответ содержит конфигурацию события.
|}
===Объекты тела ответа===
====Объект _ <code>Event</code>====
Конфигурация события.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|eventType
|string
|Тип события.
Может быть <code>null</code>.
|-
|entityId
|EntityStub
|Краткое представление отслеживаемого объекта.
Может быть <code>null</code>.
|-
|entityTags
|METag[]
|Список тегов связанного объекта.
Может быть <code>null</code>.
|-
|underMaintenance
|boolean
|Если <code>true</code>, событие произошло, когда отслеживаемая система находилась на обслуживании.
Может быть <code>null</code>.
|-
|suppressAlert
|boolean
|Состояние предупреждения во время технического обслуживания :
*<code>false</code>: Оповещение работает как обычно.
*<code>true</code>: Оповещение отключено.
Может быть <code>null</code>.
|-
|suppressProblem
|boolean
|Статус обнаружения проблемы во время технического обслуживания :
*<code>false</code>: Обнаружение проблем работает как обычно.
*<code>true</code>: обнаружение проблем отключено.
Может быть <code>null</code>.
|-
|frequentEvent
|boolean
|Если <code>true</code>, событие происходит часто .
Частое событие не вызывает проблем.

Может быть <code>null</code>.
|-
|managementZones
|ManagementZone[]
|Список всех зон управления, которым принадлежит событие.
Может быть <code>null</code>.
|-
|eventId
|string
|Идентификатор события.
Может быть <code>null</code>.
|-
|properties
|EventProperty[]
|Список свойств события.
Может быть <code>null</code>.
|-
|статус
|string
|Статус события.
Элемент может содержать эти значения

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

Может быть <code>null</code>.
|-
|title
|string
|Название события.
Может быть <code>null</code>.
|-
|correlationId
|string
|Идентификатор корреляции события.
Может быть <code>null</code>.
|}
====Объект _ <code>EntityStub</code>====
Краткое представление отслеживаемого объекта.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|entityId
|EntityId
|Краткое представление отслеживаемого объекта.
Может быть <code>null</code>.
|-
|name
|string
|Имя сущности.
Не включается в ответ, если сущность с соответствующим идентификатором не найдена.

Может быть <code>null</code>.
|}
====Объект _ <code>EntityId</code>====
Краткое представление отслеживаемого объекта.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|id
|string
|Идентификатор сущности.
Может быть <code>null</code>.
|-
|type
|string
|Тип сущности.
Может быть <code>null</code>.
|}
====Объект _ <code>METag</code>====
Тег отслеживаемого объекта.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|stringRepresentation
|string
|Строковое представление тега.
Может быть <code>null</code>.
|-
|value
|string
|Значение тега.
Может быть <code>null</code>.
|-
|key
|string
|Ключ тега.
Может быть <code>null</code>.
|-
|context
|string
|Происхождение тега, например AWS или Cloud Foundry.
Пользовательские теги используют это <code>CONTEXTLESS</code>значение.

Может быть <code>null</code>.
|}
====Объект _ <code>ManagementZone</code>====
Краткое представление зоны управления.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|name
|string
|Имя зоны управления.
Может быть <code>null</code>.
|-
|id
|string
|Идентификатор зоны управления.
Может быть <code>null</code>.
|}
====Объект _ <code>EventProperty</code>====
Свойство события.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|value
|string
|Значение свойства события.
Может быть <code>null</code>.
|-
|key
|string
|Ключ свойства события.
Может быть <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 передается в заголовке авторизации .
====Curl====
<code>curl --request GET \
--url <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events/6375436663535938547_1628496488654</nowiki> \
--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
====URL-адрес запроса====
<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/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