GET типа события
Материал из Документация Ключ-АСТРОМ
Версия от 16:29, 17 июня 2024; ENetrebin (обсуждение | вклад)
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 | Уровень серьезности, связанный с типом события.
Элемент может содержать эти значения
Может быть |
displayName | string | Отображаемое имя типа события.
Может быть |
type | string | Тип события.
Может быть |
description | string | Краткое описание типа события.
Может быть |
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