GET списка событий - Конфигурации мониторинга: различия между версиями

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

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

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

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

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

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

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

Параметры

Параметр	Тип	Описание	In	Необходимость
extensionName	string	Имя запрошенного расширения 2.0.	path	требуется
configurationId	string	Идентификатор запрошенной конфигурации мониторинга.	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`).	query	по желанию
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`: годы Если не установлено, используется текущая метка времени.	query	по желанию
dt.entity.host	string	Хост, который использует эту конфигурацию мониторинга. Пример:`HOST-ABCDEF0123456789`	query	по желанию
dt.active_gate.id	string	Шестнадцатеричный идентификатор АктивногоШлюза, который использует эту конфигурацию мониторинга. Пример:`0x1a2b3c4d`	query	по желанию
dt.extension.ds	string	Источник данных, который использует эту конфигурацию мониторинга. Пример:`snmp`	query	по желанию
content	string	Содержание мероприятия	query	по желанию
status	string	Статус события Элемент может содержать эти значения `ERROR` `INFO` `NONE` `WARN`	query	по желанию

Ответ

Коды ответов

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

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

Объект `ExtensionEventsList`

Элемент	Тип	Описание
extensionEvents	EventDto[]	Список событий расширения.

Объект `ExtensionEventDto`

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

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

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 АппОптима|Эндпойнты среды]] / [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=GET%20%D1%81%D1%85%D0%B5%D0%BC%D1%8B%20%D1%80%D0%B0%D1%81%D1%88%D0%B8%D1%80%D0%B5%D0%BD%D0%B8%D1%8F-,%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%D0%BC%D0%BE%D0%BD%D0%B8%D1%82%D0%BE%D1%80%D0%B8%D0%BD%D0%B3%D0%B0,-GET%20%D0%B2%D1%81%D0%B5%D1%85%20%D0%BA%D0%BE%D0%BD%D1%84%D0%B8%D0%B3%D1%83%D1%80%D0%B0%D1%86%D0%B8%D0%B9 Конфигурации мониторинга] / GET списка событий'''''
 Список событий, связанных с указанной конфигурацией мониторинга.
@@ Строка 6: / Строка 7: @@
 {| class="wikitable"
 | rowspan="2" |GET
-|Managed
+|АппОптима
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}/events</nowiki></code>
 |-
@@ Строка 176: / Строка 177: @@
 |}
 ===JSON-модель тела ответа===
-  <code>{
+  <{
     "extensionEvents": [
       {
@@ Строка 188: / Строка 189: @@
       }
     ]
-  }</code>
+  }