GET списка событий - Расширения 2.0: различия между версиями
ENetrebin (обсуждение | вклад) (Новая страница: «'''''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|Эндп...») |
(нет различий)
|
Текущая версия на 19:42, 17 июня 2024
API Ключ-АСТРОМ / Эндпойнты среды / Развёртывание / Расширения 2.0 / Конфигурация среды / GET списка событий
Функция возвращает список событий, связанных с указанной конфигурацией среды.
Запрос создает application/jsonполезную нагрузку.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/environmentConfiguration/events
|
| Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/environmentConfiguration/events
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение конфигураций среды расширения ( extensionEnvironment.read) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | In | Необходимость |
|---|---|---|---|---|
| extensionName | string | Имя запрошенного расширения 2.0. | path | требуется |
| from | string | Начало запрошенного таймфрейма.
Вы можете использовать один из следующих форматов:
Если не установлено, используется относительный таймфрейм в два часа ( |
запрос | по желанию |
| to | string | Конец запрошенного периода времени.
Вы можете использовать один из следующих форматов:
Если не установлено, используется текущая метка времени. |
запрос | по желанию |
| content | string | Содержание мероприятия | запрос | по желанию |
| status | string | Статус события
Элемент может содержать эти значения
|
запрос | по желанию |
Схемы расширения
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 200 | ExtensionEventsList | Список последних событий конфигурации среды расширения |
| 404 | ErrorEnvelope | Не удалось. Запрошенный ресурс не существует. |
Объекты тела ответа
Объект ResponseBody
| Элемент | Тип | Описание |
|---|---|---|
| extensionEvents | ExtensionEventDto[] | Список событий расширения.
Может быть |
Объект ExtensionEventDto
Список событий расширения.
| Элемент | Тип | Описание |
|---|---|---|
| timestamp | string | Отметка времени события
Может быть |
| severity | string | Серьезность события
Может быть |
| content | string | Содержание мероприятия
Может быть |
| dt.entity.host | string | Хост, который использует эту конфигурацию мониторинга.
Пример: Может быть |
| dt.active_gate.id | string | Шестнадцатеричный идентификатор Active Gate, который использует эту конфигурацию мониторинга.
Пример: Может быть |
| 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"
}
]
}