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

Материал из Документация Ключ-АСТРОМ
(Новая страница: «Получает свойства типа события. Запрос создает <code>application/json</code>полезную нагрузку. {| class="...»)
 
 
(не показана 1 промежуточная версия этого же участника)
Строка 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 типа события'''''
Получает свойства типа события.
Получает свойства типа события.


Строка 7: Строка 9:
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/eventTypes/{eventType}</nowiki></code>
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/eventTypes/{eventType}</nowiki></code>
|-
|-
|Окружающая среда АктивногоШлюза
|Среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/eventTypes/{eventType}</nowiki></code>
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/eventTypes/{eventType}</nowiki></code>
|}
|}

Текущая версия на 16:29, 17 июня 2024

API Ключ-АСТРОМ / Эндпойнты среды / Развёртывание / События v2 / GET типа события

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

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

GET Managed https://{your-domain}/e/{your-environment-id}/api/v2/eventTypes/{eventType}
Среда АктивногоШлюза 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

Источник — https://doc.ruscomtech.ru/index.php?title=GET_типа_события&oldid=3782