GET всех типов событий

Материал из Документация Ключ-АСТРОМ

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

Список всех типов событий, которые могут возникнуть в вашей среде.

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

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

Этот запрос является выпуском Early Adopter и может быть изменен несовместимым образом.

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

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

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

Параметры

Параметр Тип Описание In Необходимость
nextPageKey string Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.

Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey .

Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса.

запрос необязательный
pageSize integer Количество типов событий в полезной нагрузке одного ответа.

Максимально допустимый размер страницы – 500.

Если не установлено, используется 100.

запрос необязательный

Ответ

Коды ответов

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

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

Объект EventTypeList

Список типов событий.

Элемент Тип Описание
eventTypeInfos ventType[] Список типов событий.

Может быть null.

pageSize integer Количество записей на странице.

Может быть null.

nextPageKey string Курсор для следующей страницы результатов. Имеет значение nullна последней странице.

Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.

Может быть null.

totalCount integer Общее количество записей в результате.

Объект _ EventType

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

Элемент Тип Описание
severityLevel string Уровень серьезности, связанный с типом события.

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

  • AVAILABILITY
  • CUSTOM_ALERT
  • ERROR
  • INFO
  • MONITORING_UNAVAILABLE
  • PERFORMANCE
  • RESOURCE_CONTENTION

Может быть null.

displayName string Отображаемое имя типа события.

Может быть null.

type string Тип события.

Может быть null.

description string Краткое описание типа события.

Может быть null.

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

{
  "eventTypeInfos": [
    {
      "severityLevel": "PERFORMANCE",
      "displayName": "High CPU",
      "type": "OSI_HIGH_CPU",
      "description": "string"
    }
  ],
  "pageSize": 1,
  "nextPageKey": "AQAAABQBAAAABQ==",
  "totalCount": 1
}

Пример

В этом примере в запросе перечислены все типы событий, которые можно создать в среде mySampleEnv . Результат усекается до трех записей

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

Curl

curl --request GET \
  --url 'https://mySampleEnv.live.ruscomtech.ru/api/v2/eventTypes?pageSize=3' \
  --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

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

https://mySampleEnv.live.ruscomtech.ru/api/v2/eventTypes?pageSize=3

Тело ответа

{
  "totalCount": 144,
  "pageSize": 3,
  "nextPageKey": "AQAAAGQBAAAAZA==",
  "eventTypeInfos": [
    {
      "type": "APPLICATION_UNEXPECTED_LOW_LOAD",
      "displayName": "Application low traffic",
      "severityLevel": "AVAILABILITY",
      "description": "Unexpected low traffic"
    },
      {
      "type": "MOBILE_APP_CRASH_RATE_INCREASED",
      "displayName": "Mobile app crash rate increase",
      "severityLevel": "ERROR"
    },
    {
      "type": "APPLICATION_SLOWDOWN",
      "displayName": "Application slowdown",
      "severityLevel": "PERFORMANCE",
      "description": "User action duration degradation"
    }
  ]
}

Код ответа

200