Получение списка событий2: различия между версиями
ENetrebin (обсуждение | вклад)  | 
				ENetrebin (обсуждение | вклад)   | 
				||
| Строка 8: | Строка 8: | ||
|-  | |-  | ||
|SaaS  | |SaaS  | ||
|<code><nowiki>https://{your-environment-id}.live.  | |<code><nowiki>https://{your-environment-id}.live.ruscomtech.ru/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}/events</nowiki></code>  | ||
|-  | |-  | ||
|Окружающая среда АктивныйШлюз  | |Окружающая среда АктивныйШлюз  | ||
| Строка 46: | Строка 46: | ||
* Человекочитаемый формат <code>2021-01-25T05:57:01.123+01:00</code>. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо <code>T</code>. Секунды и доли секунды не являются обязательными.  | * Человекочитаемый формат <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>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>m</code>: минуты  | ||
** <code>h</code>: часы  | ** <code>h</code>: часы  | ||
** <code>d</code>:   | ** <code>d</code>: дни  | ||
** <code>w</code>: недели  | ** <code>w</code>: недели  | ||
** <code>M</code>: месяцы  | ** <code>M</code>: месяцы  | ||
| Строка 66: | Строка 66: | ||
* Человекочитаемый формат <code>2021-01-25T05:57:01.123+01:00</code>. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо <code>T</code>. Секунды и доли секунды не являются обязательными.  | * Человекочитаемый формат <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>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>m</code>: минуты  | ||
** <code>h</code>: часы  | ** <code>h</code>: часы  | ||
** <code>d</code>:   | ** <code>d</code>: дни  | ||
** <code>w</code>: недели  | ** <code>w</code>: недели  | ||
** <code>M</code>: месяцы  | ** <code>M</code>: месяцы  | ||
| Строка 87: | Строка 87: | ||
|dt.active_gate.id  | |dt.active_gate.id  | ||
|string  | |string  | ||
|Шестнадцатеричный идентификатор   | |Шестнадцатеричный идентификатор АктивногоШлюза, который использует эту конфигурацию мониторинга.  | ||
Пример:<code>0x1a2b3c4d</code>  | Пример:<code>0x1a2b3c4d</code>  | ||
| Строка 140: | Строка 140: | ||
=== Объекты тела ответа ===  | === Объекты тела ответа ===  | ||
==== Объект   | ==== Объект <code>ExtensionEventsList</code> ====  | ||
{| class="wikitable"  | {| class="wikitable"  | ||
!Элемент  | !Элемент  | ||
| Строка 147: | Строка 147: | ||
|-  | |-  | ||
|extensionEvents  | |extensionEvents  | ||
|  | |EventDto[]  | ||
|Список событий расширения.  | |Список событий расширения.  | ||
|}  | |}  | ||
==== Объект   | ==== Объект <code>ExtensionEventDto</code> ====  | ||
Список событий расширения.  | Список событий расширения.  | ||
{| class="wikitable"  | {| class="wikitable"  | ||
Версия 10:26, 7 октября 2022
Список событий, связанных с указанной конфигурацией мониторинга.
Запрос создает 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"
    }
  ]
}