Получение списка событий2: различия между версиями

Материал из Документация Ключ-АСТРОМ
(Новая страница: «Список событий, связанных с указанной конфигурацией мониторинга. Запрос создает <code>applic...»)
 
 
(не показана 1 промежуточная версия этого же участника)
Строка 3: Строка 3:
Запрос создает <code>application/json</code>полезную нагрузку.
Запрос создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
{| class="wikitable"
| rowspan="3" |ПОЛУЧИТЬ
| rowspan="3" |GET
|Удалось
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}/events</nowiki></code>
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}/events</nowiki></code>
|-
|-
|SaaS
|SaaS
|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}/events</nowiki></code>
|<code><nowiki>https://{your-environment-id}.live.ruscomtech.ru/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}/events</nowiki></code>
|-
|-
|Окружающая среда ActiveGate
|Окружающая среда АктивныйШлюз
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}/events</nowiki></code>
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}/events</nowiki></code>
|}
|}


== Аутентификация ==
== Аутентификация ==
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение конфигураций мониторинга расширений ( <code>extensionConfigurations.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия '''Чтение конфигураций мониторинга расширений''' ( <code>extensionConfigurations.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .


== Параметры ==
== Параметры ==
Строка 22: Строка 22:
!Тип
!Тип
!Описание
!Описание
!В
!In
!Необходимый
!Необходимость
|-
|-
|имя_расширения
|extensionName
|нить
|string
|Имя запрошенного расширения 2.0.
|Имя запрошенного расширения 2.0.
|дорожка
|path
|требуется
|требуется
|-
|-
|идентификатор конфигурации
|configurationId
|нить
|string
|Идентификатор запрошенной конфигурации мониторинга.
|Идентификатор запрошенной конфигурации мониторинга.
|дорожка
|path
|требуется
|требуется
|-
|-
|из
|from
|нить
|string
|Начало запрошенного таймфрейма.
|Начало запрошенного таймфрейма.


Строка 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>: месяцы
Строка 54: Строка 54:


Если не установлено, используется относительный таймфрейм в два часа ( <code>now-2h</code>).
Если не установлено, используется относительный таймфрейм в два часа ( <code>now-2h</code>).
|запрос
|query
|по желанию
|по желанию
|-
|-
|к
|to
|нить
|string
|Конец запрошенного периода времени.
|Конец запрошенного периода времени.


Строка 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>: месяцы
Строка 74: Строка 74:


Если не установлено, используется текущая метка времени.
Если не установлено, используется текущая метка времени.
|запрос
|query
|по желанию
|по желанию
|-
|-
|dt.entity.host
|dt.entity.host
|нить
|string
|Хост, который использует эту конфигурацию мониторинга.
|Хост, который использует эту конфигурацию мониторинга.


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


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


Пример:<code>snmp</code>
Пример:<code>snmp</code>
|запрос
|query
|по желанию
|по желанию
|-
|-
|содержание
|content
|нить
|string
|Содержание мероприятия
|Содержание мероприятия
|запрос
|query
|по желанию
|по желанию
|-
|-
|статус
|status
|нить
|string
|Статус события
|Статус события


Строка 117: Строка 117:
* <code>NONE</code>
* <code>NONE</code>
* <code>WARN</code>
* <code>WARN</code>
|запрос
|query
|по желанию
|по желанию
|}
|}
Строка 140: Строка 140:
=== Объекты тела ответа ===
=== Объекты тела ответа ===


==== Объект _ <code>ExtensionEventsList</code> ====
==== Объект <code>ExtensionEventsList</code> ====
{| class="wikitable"
{| class="wikitable"
!Элемент
!Элемент
Строка 147: Строка 147:
|-
|-
|extensionEvents
|extensionEvents
|Событие расширения Dto []
|EventDto[]
|Список событий расширения.
|Список событий расширения.
|}
|}


==== Объект _ <code>ExtensionEventDto</code> ====
==== Объект <code>ExtensionEventDto</code> ====
Список событий расширения.
Список событий расширения.
{| class="wikitable"
{| class="wikitable"
Строка 158: Строка 158:
!Описание
!Описание
|-
|-
|отметка времени
|timestamp
|нить
|string
|Отметка времени события
|Отметка времени события
|-
|-
|строгость
|severity
|нить
|string
|Серьезность события
|Серьезность события
|-
|-
|содержание
|content
|нить
|string
|Содержание мероприятия
|Содержание мероприятия
|-
|-
|dt.entity.host
|dt.entity.host
|нить
|string
|Хост, который использует эту конфигурацию мониторинга.
|Хост, который использует эту конфигурацию мониторинга.


Строка 177: Строка 177:
|-
|-
|dt.active_gate.id
|dt.active_gate.id
|нить
|string
|Шестнадцатеричный идентификатор Active Gate, который использует эту конфигурацию мониторинга.
|Шестнадцатеричный идентификатор АктивногоШлюза, который использует эту конфигурацию мониторинга.


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


Пример:<code>snmp</code>
Пример:<code>snmp</code>
|-
|-
|статус
|status
|нить
|string
|Статус события
|Статус события



Текущая версия на 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 Начало запрошенного таймфрейма.

Вы можете использовать один из следующих форматов:

  • Отметка времени в миллисекундах 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"
    }
  ]
}