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

Материал из Документация Ключ-АСТРОМ
(Новая страница: «Функция возвращает список событий, связанных с указанной конфигурацией среды. Запрос с...»)
 
Строка 86: Строка 86:
|}
|}


== Шаг 2. Разверните Dynatrace ==
== Схемы расширения ==


=== Коды ответов ===
=== Коды ответов ===
Строка 105: Строка 105:
=== Объекты тела ответа ===
=== Объекты тела ответа ===


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


Строка 118: Строка 118:
|}
|}


==== Объект _ <code>ExtensionEventDto</code> ====
==== Объект <code>ExtensionEventDto</code> ====
Список событий расширения.
Список событий расширения.
{| class="wikitable"
{| class="wikitable"
Строка 125: Строка 125:
!Описание
!Описание
|-
|-
|отметка времени
|timestamp
|нить
|string
|Отметка времени события
|Отметка времени события


Может быть <code>null</code>.
Может быть <code>null</code>.
|-
|-
|строгость
|severity
|нить
|string
|Серьезность события
|Серьезность события


Может быть <code>null</code>.
Может быть <code>null</code>.
|-
|-
|содержание
|content
|нить
|string
|Содержание мероприятия
|Содержание мероприятия


Строка 144: Строка 144:
|-
|-
|dt.entity.host
|dt.entity.host
|нить
|string
|Хост, который использует эту конфигурацию мониторинга.
|Хост, который использует эту конфигурацию мониторинга.


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


Строка 160: Строка 160:
|-
|-
|dt.extension.ds
|dt.extension.ds
|нить
|string
|Источник данных, который использует эту конфигурацию мониторинга.
|Источник данных, который использует эту конфигурацию мониторинга.


Строка 167: Строка 167:
Может быть <code>null</code>.
Может быть <code>null</code>.
|-
|-
|статус
|status
|нить
|string
|Статус события
|Статус события



Версия 09:15, 12 июля 2022

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

Запрос создает application/jsonполезную нагрузку.

GET Managed https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/environmentConfiguration/events
SaaS https://{your-environment-id}.live.dynatrace.com/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 Начало запрошенного таймфрейма.

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

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

запрос по желанию
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: годы

Если не установлено, используется текущая метка времени.

запрос по желанию
content string Содержание мероприятия запрос по желанию
status string Статус события

Элемент может содержать эти значения

запрос по желанию

Схемы расширения

Коды ответов

Код Тип Описание
200 Список событий расширения Список последних событий конфигурации среды расширения
404 Конверт ошибки Не удалось. Запрошенный ресурс не существует.

Объекты тела ответа

Объект ResponseBody

Элемент Тип Описание
extensionEvents ExtensionEventDto[] Список событий расширения.

Может быть null.

Объект ExtensionEventDto

Список событий расширения.

Элемент Тип Описание
timestamp string Отметка времени события

Может быть null.

severity string Серьезность события

Может быть null.

content string Содержание мероприятия

Может быть null.

dt.entity.host string Хост, который использует эту конфигурацию мониторинга.

Пример:HOST-ABCDEF0123456789

Может быть null.

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

Пример:0x1a2b3c4d

Может быть null.

dt.extension.ds string Источник данных, который использует эту конфигурацию мониторинга.

Пример:snmp

Может быть null.

status string Статус события

Элемент может содержать эти значения

Может быть null.

JSON-модель тела ответа

{
  "extensionEvents": [
    {
      "timestamp": "string",
      "severity": "string",
      "content": "string",
      "dt.entity.host": "string",
      "dt.active_gate.id": "string",
      "dt.extension.ds": "string",
      "status": "ERROR"
    }
  ]
}