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

Текущая версия от 21:07, 25 декабря 2024

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

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

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

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

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

@@ Строка 7: / Строка 7: @@
 Этот запрос является выпуском Early Adopter и может быть изменен несовместимым образом.
 {| class="wikitable"
-| rowspan="3" |GET
+| rowspan="2" |GET
-|Managed
+|АппОптима
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/eventTypes</nowiki></code>
 |-
-|SaaS
+|Среда АктивногоШлюза
-|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/eventTypes</nowiki></code>
-|-
-|Окружающая среда АктивногоШлюза
 |<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/eventTypes</nowiki></code>
 |}
@@ Строка 26: / Строка 23: @@
 !Тип
 !Описание
-!В
+!In
-!Необходимый
+!Необходимость
 |-
-|ключ следующей страницы
+|nextPageKey
 |string
 |Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.
@@ Строка 39: / Строка 36: @@
 |необязательный
 |-
-|размер страницы
+|pageSize
 |integer
 |Количество типов событий в полезной нагрузке одного ответа.
@@ Строка 59: / Строка 56: @@
 |-
 |200
-|Список типов событий
+|EventTypeList
 |Успех
 |}
@@ Строка 72: / Строка 69: @@
 !Описание
 |-
-|информация о типе события
+|eventTypeInfos
-|Тип события []
+|ventType[]
 |Список типов событий.
 Может быть <code>null</code>.
 |-
-|размер страницы
+|pageSize
 |integer
 |Количество записей на странице.
@@ Строка 84: / Строка 81: @@
 Может быть <code>null</code>.
 |-
-|ключ следующей страницы
+|nextPageKey
 |string
 |Курсор для следующей страницы результатов. Имеет значение <code>null</code>на последней странице.
@@ Строка 92: / Строка 89: @@
 Может быть <code>null</code>.
 |-
-|общее количество
+|totalCount
 |integer
 |Общее количество записей в результате.
@@ Строка 104: / Строка 101: @@
 !Описание
 |-
-|Уровень опасности
+|severityLevel
 |string
 |Уровень серьезности, связанный с типом события.
@@ Строка 120: / Строка 117: @@
 Может быть <code>null</code>.
 |-
-|отображаемое имя
+|displayName
 |string
 |Отображаемое имя типа события.
@@ Строка 126: / Строка 123: @@
 Может быть <code>null</code>.
 |-
-|тип
+|type
 |string
 |Тип события.
@@ Строка 132: / Строка 129: @@
 Может быть <code>null</code>.
 |-
-|описание
+|description
 |string
 |Краткое описание типа события.
@@ Строка 140: / Строка 137: @@
 === JSON-модель тела ответа ===
-  <code>{
+  <{
     "eventTypeInfos": [
       {
@@ Строка 159: / Строка 156: @@
 Маркер API передается в заголовке авторизации .
-==== Завиток ====
+==== Curl ====
-  <code>curl --request GET \
+  <curl --request GET \
-    --url '<nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/eventTypes?pageSize=3'</nowiki> \
+    --url '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/eventTypes?pageSize=3'</nowiki> \
     --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
 ==== URL-адрес запроса ====
-  <code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/eventTypes?pageSize=3</nowiki></code>
+  <code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/eventTypes?pageSize=3</nowiki></code>
 ==== Тело ответа ====
-  <code>{
+  <{
     "totalCount": 144,
     "pageSize": 3,