Получение списка событий2
Список событий, связанных с указанной конфигурацией мониторинга.
Запрос создает application/json
полезную нагрузку.
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}/events
|
SaaS | https://{your-environment-id}.live.ruscomtech.ru/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 | Начало запрошенного таймфрейма.
Вы можете использовать один из следующих форматов:
Если не установлено, используется относительный таймфрейм в два часа ( |
query | по желанию |
to | string | Конец запрошенного периода времени.
Вы можете использовать один из следующих форматов:
Если не установлено, используется текущая метка времени. |
query | по желанию |
dt.entity.host | string | Хост, который использует эту конфигурацию мониторинга.
Пример: |
query | по желанию |
dt.active_gate.id | string | Шестнадцатеричный идентификатор АктивногоШлюза, который использует эту конфигурацию мониторинга.
Пример: |
query | по желанию |
dt.extension.ds | string | Источник данных, который использует эту конфигурацию мониторинга.
Пример: |
query | по желанию |
content | string | Содержание мероприятия | query | по желанию |
status | string | Статус события
Элемент может содержать эти значения
|
query | по желанию |
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
200 | Список событий расширения | Успех |
404 | ErrorEnvelope | Не удалось. Запрошенный ресурс не существует. |
Объекты тела ответа
Объект ExtensionEventsList
Элемент | Тип | Описание |
---|---|---|
extensionEvents | EventDto[] | Список событий расширения. |
Объект ExtensionEventDto
Список событий расширения.
Элемент | Тип | Описание |
---|---|---|
timestamp | string | Отметка времени события |
severity | string | Серьезность события |
content | string | Содержание мероприятия |
dt.entity.host | string | Хост, который использует эту конфигурацию мониторинга.
Пример: |
dt.active_gate.id | string | Шестнадцатеричный идентификатор АктивногоШлюза, который использует эту конфигурацию мониторинга.
Пример: |
dt.extension.ds | string | Источник данных, который использует эту конфигурацию мониторинга.
Пример: |
status | string | Статус события
Элемент может содержать эти значения
|
JSON-модель тела ответа
{
"extensionEvents": [
{
"timestamp": "string",
"severity": "string",
"content": "string",
"dt.entity.host": "string",
"dt.active_gate.id": "string",
"dt.extension.ds": "string",
"status": "ERROR"
}
]
}