GET списка событий - Расширения 2.0: различия между версиями

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

API АппОптима / Эндпойнты среды / Развёртывание / Расширения 2.0 / Конфигурация среды / GET списка событий

Функция возвращает список событий, связанных с указанной конфигурацией среды.

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

GET	АппОптима	`https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/environmentConfiguration/events`
GET	Среда АктивногоШлюза	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/environmentConfiguration/events`

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

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

Параметры

Параметр	Тип	Описание	In	Необходимость
extensionName	string	Имя запрошенного расширения 2.0.	path	требуется
from	string	Начало запрошенного таймфрейма. Вы можете использовать один из следующих форматов: Отметка времени в миллисекундах UTC. Читаемый формат `2021-01-25T05:57:01.123+01:00`. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо `T`. Секунды и доли секунды не являются обязательными. Относительный таймфрейм, назад. Формат: `now-NU/A`, где `N`количество времени, `U`единица времени и `A`выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, `now-1y/w`это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: `now-NU`. Поддерживаемые единицы времени для относительного таймфрейма: `m`: минуты `h`: часы `d`: дни `w`: недели `M`: месяцы `y`: годы Если не установлено, используется относительный таймфрейм в два часа ( `now-2h`).	запрос	по желанию
to	string	Конец запрошенного периода времени. Вы можете использовать один из следующих форматов: Отметка времени в миллисекундах UTC. Читаемый формат `2021-01-25T05:57:01.123+01:00`. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо `T`. Секунды и доли секунды не являются обязательными. Относительный таймфрейм, назад. Формат: `now-NU/A`, где `N`количество времени, `U`единица времени и `A`выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, `now-1y/w`это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: `now-NU`. Поддерживаемые единицы времени для относительного таймфрейма: `m`: минуты `h`: часы `d`: дни `w`: недели `M`: месяцы `y`: годы Если не установлено, используется текущая метка времени.	запрос	по желанию
content	string	Содержание мероприятия	запрос	по желанию
status	string	Статус события Элемент может содержать эти значения `ERROR` `INFO` `NONE` `WARN`	запрос	по желанию

Схемы расширения

Коды ответов

Код	Тип	Описание
200	ExtensionEventsList	Список последних событий конфигурации среды расширения
404	ErrorEnvelope	Не удалось. Запрошенный ресурс не существует.

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

Объект `ResponseBody`

Элемент	Тип	Описание
extensionEvents	ExtensionEventDto[]	Список событий расширения. Может быть `null`.

Объект `ExtensionEventDto`

Список событий расширения.

Элемент	Тип	Описание
timestamp	string	Отметка времени события Может быть `null`.
severity	string	Серьезность события Может быть `null`.
content	string	Содержание мероприятия Может быть `null`.
dt.entity.host	string	Хост, который использует эту конфигурацию мониторинга. Пример:`HOST-ABCDEF0123456789` Может быть `null`.
dt.active_gate.id	string	Шестнадцатеричный идентификатор Active Gate, который использует эту конфигурацию мониторинга. Пример:`0x1a2b3c4d` Может быть `null`.
dt.extension.ds	string	Источник данных, который использует эту конфигурацию мониторинга. Пример:`snmp` Может быть `null`.
status	string	Статус события Элемент может содержать эти значения Может быть `null`.

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

<{
  "extensionEvents": [
    {
      "timestamp": "string",
      "severity": "string",
      "content": "string",
      "dt.entity.host": "string",
      "dt.active_gate.id": "string",
      "dt.extension.ds": "string",
      "status": "ERROR"
    }
  ]
}

@@ Строка 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|Развёртывание]] / Расширения 2.0 / Конфигурация среды / GET списка событий'''''
+'''''[[API АппОптима]] / [[API АппОптима|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%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,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=GET%20%D1%81%D0%B2%D0%BE%D0%B9%D1%81%D1%82%D0%B2%D0%B0%20%D1%81%D0%BE%D0%B1%D1%8B%D1%82%D0%B8%D1%8F-,%D0%A0%D0%B0%D1%81%D1%88%D0%B8%D1%80%D0%B5%D0%BD%D0%B8%D1%8F%202.0,-%D0%9A%D0%BE%D0%BD%D1%84%D0%B8%D0%B3%D1%83%D1%80%D0%B0%D1%86%D0%B8%D0%B8%20%D1%81%D1%80%D0%B5%D0%B4%D1%8B Расширения 2.0] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%A0%D0%B0%D1%81%D1%88%D0%B8%D1%80%D0%B5%D0%BD%D0%B8%D1%8F%202.0-,%D0%9A%D0%BE%D0%BD%D1%84%D0%B8%D0%B3%D1%83%D1%80%D0%B0%D1%86%D0%B8%D0%B8%20%D1%81%D1%80%D0%B5%D0%B4%D1%8B,-GET%20%D0%BA%D0%BE%D0%BD%D1%84%D0%B8%D0%B3%D1%83%D1%80%D0%B0%D1%86%D0%B8%D0%B8%20%D1%81%D1%80%D0%B5%D0%B4%D1%8B Конфигурация среды] / GET списка событий'''''
 Функция возвращает список событий, связанных с указанной конфигурацией среды.
@@ Строка 6: / Строка 6: @@
 {| class="wikitable"
 | rowspan="2" |GET
-|Managed
+|АппОптима
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/environmentConfiguration/events</nowiki></code>
 |-
@@ Строка 157: / Строка 157: @@
 |}
 ===JSON-модель тела ответа===
-  <code>{
+  <{
     "extensionEvents": [
       {
@@ Строка 169: / Строка 169: @@
       }
     ]
-  }</code>
+  }