GET списка событий - Конфигурации мониторинга

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

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

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

GET	Managed	https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}/events
	Среда АктивныйШлюз	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"
    }
  ]
}