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

Материал из Документация Ключ-АСТРОМ
(Новая страница: «Список всех типов событий, которые могут возникнуть в вашей среде. Запрос создает <code>appli...»)
 
Строка 7: Строка 7:
Этот запрос является выпуском Early Adopter и может быть изменен несовместимым образом.
Этот запрос является выпуском Early Adopter и может быть изменен несовместимым образом.
{| class="wikitable"
{| class="wikitable"
| rowspan="3" |ПОЛУЧИТЬ
| rowspan="3" |GET
|Удалось
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/eventTypes</nowiki></code>
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/eventTypes</nowiki></code>
|-
|-
Строка 14: Строка 14:
|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/eventTypes</nowiki></code>
|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/eventTypes</nowiki></code>
|-
|-
|Окружающая среда ActiveGate
|Окружающая среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/eventTypes</nowiki></code>
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/eventTypes</nowiki></code>
|}
|}


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


== Параметры ==
== Параметры ==
Строка 30: Строка 30:
|-
|-
|ключ следующей страницы
|ключ следующей страницы
|нить
|string
|Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.
|Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.


Строка 85: Строка 85:
|-
|-
|ключ следующей страницы
|ключ следующей страницы
|нить
|string
|Курсор для следующей страницы результатов. Имеет значение <code>null</code>на последней странице.
|Курсор для следующей страницы результатов. Имеет значение <code>null</code>на последней странице.


Строка 105: Строка 105:
|-
|-
|Уровень опасности
|Уровень опасности
|нить
|string
|Уровень серьезности, связанный с типом события.
|Уровень серьезности, связанный с типом события.


Строка 121: Строка 121:
|-
|-
|отображаемое имя
|отображаемое имя
|нить
|string
|Отображаемое имя типа события.
|Отображаемое имя типа события.


Строка 127: Строка 127:
|-
|-
|тип
|тип
|нить
|string
|Тип события.
|Тип события.


Строка 133: Строка 133:
|-
|-
|описание
|описание
|нить
|string
|Краткое описание типа события.
|Краткое описание типа события.



Версия 12:09, 14 апреля 2022

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

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

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

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

GET Managed https://{your-domain}/e/{your-environment-id}/api/v2/eventTypes
SaaS https://{your-environment-id}.live.dynatrace.com/api/v2/eventTypes
Окружающая среда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/v2/eventTypes

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

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

Параметры

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

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

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

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

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

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

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

Ответ

Коды ответов

Код Тип Описание
200 Список типов событий Успех

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

Объект _ EventTypeList

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

Элемент Тип Описание
информация о типе события Тип события [] Список типов событий.

Может быть null.

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

Может быть null.

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

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

Может быть null.

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

Объект _ EventType

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

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

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

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

Может быть null.

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

Может быть null.

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

Может быть null.

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

Может быть null.

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

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

Пример

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

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

Завиток

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

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

https://mySampleEnv.live.dynatrace.com/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