Получение списка событий2: различия между версиями
ENetrebin (обсуждение | вклад) (Новая страница: «Список событий, связанных с указанной конфигурацией мониторинга. Запрос создает <code>applic...») |
ENetrebin (обсуждение | вклад) |
||
(не показаны 2 промежуточные версии этого же участника) | |||
Строка 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> | ||
|- | |- | ||
Строка 10: | Строка 10: | ||
|<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.dynatrace.com/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><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 | ||
|Шестнадцатеричный идентификатор | |Шестнадцатеричный идентификатор АктивногоШлюза, который использует эту конфигурацию мониторинга. | ||
Пример:<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> ==== | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
Строка 147: | Строка 147: | ||
|- | |- | ||
|extensionEvents | |extensionEvents | ||
| | |EventDto[] | ||
|Список событий расширения. | |Список событий расширения. | ||
|} | |} | ||
==== Объект | ==== Объект <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 | ||
|Шестнадцатеричный идентификатор | |Шестнадцатеричный идентификатор АктивногоШлюза, который использует эту конфигурацию мониторинга. | ||
Пример:<code>0x1a2b3c4d</code> | Пример:<code>0x1a2b3c4d</code> | ||
|- | |- | ||
|dt.extension.ds | |dt.extension.ds | ||
| | |string | ||
|Источник данных, который использует эту конфигурацию мониторинга. | |Источник данных, который использует эту конфигурацию мониторинга. | ||
Пример:<code>snmp</code> | Пример:<code>snmp</code> | ||
|- | |- | ||
| | |status | ||
| | |string | ||
|Статус события | |Статус события | ||
Текущая версия на 18:20, 25 января 2023
Список событий, связанных с указанной конфигурацией мониторинга.
Запрос создает application/json
полезную нагрузку.
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}/events
|
SaaS | https://{your-environment-id}.live.dynatrace.com/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"
}
]
}