GET типа события: различия между версиями

Текущая версия от 14:18, 24 декабря 2024

API АппОптима / Эндпойнты среды / Развёртывание / События v2 / GET типа события

Получает свойства типа события.

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

GET	АппОптима	`https://{your-domain}/e/{your-environment-id}/api/v2/eventTypes/{eventType}`
GET	Среда АктивногоШлюза	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/eventTypes/{eventType}`

Аутентификация

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

Параметры

Параметр	Тип	Описание	In	Необходимость
eventType	string	Тип события, который вы запрашиваете.	дорожка	обязательный

Ответ

Коды ответов

Код	Тип	Описание
200	EventType	Успех

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

Объект `EventType`

Конфигурация типа события.

Элемент	Тип	Описание
severityLevel	string	Уровень серьезности, связанный с типом события. Элемент может содержать эти значения `AVAILABILITY` `CUSTOM_ALERT` `ERROR` `INFO` `MONITORING_UNAVAILABLE` `PERFORMANCE` `RESOURCE_CONTENTION` Может быть `null`.
displayName	string	Отображаемое имя типа события. Может быть `null`.
type	string	Тип события. Может быть `null`.
description	string	Краткое описание типа события. Может быть `null`.

JSON-модель тела ответа

<{
  "severityLevel": "PERFORMANCE",
  "displayName": "High CPU",
  "type": "OSI_HIGH_CPU",
  "description": "string"
}

Пример

В этом примере запрос запрашивает свойства типа APPLICATION_SLOWDOWN .

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

Curl

<curl --request GET \
  --url 'https://mySampleEnv.live.ruscomtech.com/api/v2/eventTypes/APPLICATION_SLOWDOWN' \
  --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

URL-адрес запроса

https://mySampleEnv.live.ruscomtech.com/api/v2/eventTypes/APPLICATION_SLOWDOWN

Тело ответа

<{
  "type": "APPLICATION_SLOWDOWN",
  "displayName": "Application slowdown",
  "severityLevel": "PERFORMANCE",
  "description": "User action duration degradation"
}

Код ответа

200

@@ Строка 1: / Строка 1: @@
-'''''[[API АппОптима]] / [[API АппОптима|Эндпойнты среды]] / [[API АппОптима#:~:text=DELETE тегов-,Развёртывание,-править|Развёртывание]] / [[API АппОптима#:~:text=развертывания из Jenkins-,События v2,-GET списка событий|События v2]] / GET типа события'''''
+'''''[[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 типа события'''''
 Получает свойства типа события.
@@ Строка 81: / Строка 81: @@
     "type": "OSI_HIGH_CPU",
     "description": "string"
-  }</code>
+  }
 ==Пример==
 В этом примере запрос запрашивает свойства типа APPLICATION_SLOWDOWN .
@@ Строка 89: / Строка 89: @@
   <curl --request GET \
     --url '<nowiki>https://mySampleEnv.live.ruscomtech.com/api/v2/eventTypes/APPLICATION_SLOWDOWN'</nowiki> \
-    --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
+    --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
 ====URL-адрес запроса====
   <code><nowiki>https://mySampleEnv.live.ruscomtech.com/api/v2/eventTypes/APPLICATION_SLOWDOWN</nowiki></code>
@@ Строка 98: / Строка 98: @@
     "severityLevel": "PERFORMANCE",
     "description": "User action duration degradation"
-  }</code>
+  }
 ====Код ответа====