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|Эндп...»

2024-06-17T19:42:24Z

Новая страница: «'''''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 Ключ-АСТРОМ]] / [[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 списка событий'''''

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

Запрос создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
| rowspan="2" |GET
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/environmentConfiguration/events</nowiki></code>
|-
|Среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/environmentConfiguration/events</nowiki></code>
|}
==Аутентификация==
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия '''Чтение конфигураций среды расширения''' ( <code>extensionEnvironment.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .
==Параметры==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|extensionName
|string
|Имя запрошенного расширения 2.0.
|path
|требуется
|-
|from
|string
|Начало запрошенного таймфрейма.
Вы можете использовать один из следующих форматов:
*Отметка времени в миллисекундах UTC.
*Читаемый формат <code>2021-01-25T05:57:01.123+01:00</code>. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо <code>T</code>. Секунды и доли секунды не являются обязательными.
*Относительный таймфрейм, назад. Формат: <code>now-NU/A</code>, где <code>N</code>количество времени, <code>U</code>единица времени и <code>A</code>выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, <code>now-1y/w</code>это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: <code>now-NU</code>. Поддерживаемые единицы времени для относительного таймфрейма:
**<code>m</code>: минуты
**<code>h</code>: часы
**<code>d</code>: дни
**<code>w</code>: недели
**<code>M</code>: месяцы
**<code>y</code>: годы
Если не установлено, используется относительный таймфрейм в два часа ( <code>now-2h</code>).
|запрос
|по желанию
|-
|to
|string
|Конец запрошенного периода времени.
Вы можете использовать один из следующих форматов:
*Отметка времени в миллисекундах UTC.
*Читаемый формат <code>2021-01-25T05:57:01.123+01:00</code>. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо <code>T</code>. Секунды и доли секунды не являются обязательными.
*Относительный таймфрейм, назад. Формат: <code>now-NU/A</code>, где <code>N</code>количество времени, <code>U</code>единица времени и <code>A</code>выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, <code>now-1y/w</code>это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: <code>now-NU</code>. Поддерживаемые единицы времени для относительного таймфрейма:
**<code>m</code>: минуты
**<code>h</code>: часы
**<code>d</code>: дни
**<code>w</code>: недели
**<code>M</code>: месяцы
**<code>y</code>: годы
Если не установлено, используется текущая метка времени.
|запрос
|по желанию
|-
|content
|string
|Содержание мероприятия
|запрос
|по желанию
|-
|status
|string
|Статус события
Элемент может содержать эти значения
*<code>ERROR</code>
*<code>INFO</code>
*<code>NONE</code>
*<code>WARN</code>
|запрос
|по желанию
|}
==Схемы расширения==
===Коды ответов===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|ExtensionEventsList
|Список последних событий конфигурации среды расширения
|-
|404
|ErrorEnvelope
|Не удалось. Запрошенный ресурс не существует.
|}
===Объекты тела ответа===
====Объект <code>ResponseBody</code>====
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|extensionEvents
|ExtensionEventDto[]
|Список событий расширения.
Может быть <code>null</code>.
|}
====Объект <code>ExtensionEventDto</code>====
Список событий расширения.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|timestamp
|string
|Отметка времени события
Может быть <code>null</code>.
|-
|severity
|string
|Серьезность события
Может быть <code>null</code>.
|-
|content
|string
|Содержание мероприятия
Может быть <code>null</code>.
|-
|dt.entity.host
|string
|Хост, который использует эту конфигурацию мониторинга.
Пример:<code>HOST-ABCDEF0123456789</code>

Может быть <code>null</code>.
|-
|dt.active_gate.id
|string
|Шестнадцатеричный идентификатор Active Gate, который использует эту конфигурацию мониторинга.
Пример:<code>0x1a2b3c4d</code>

Может быть <code>null</code>.
|-
|dt.extension.ds
|string
|Источник данных, который использует эту конфигурацию мониторинга.
Пример:<code>snmp</code>

Может быть <code>null</code>.
|-
|status
|string
|Статус события
Элемент может содержать эти значения

Может быть <code>null</code>.
|}
===JSON-модель тела ответа===
<code>{
"extensionEvents": [
{
"timestamp": "string",
"severity": "string",
"content": "string",
"dt.entity.host": "string",
"dt.active_gate.id": "string",
"dt.extension.ds": "string",
"status": "ERROR"
}
]
}</code>

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|Эндп...»