Получение события: различия между версиями
Материал из Документация Ключ-АСТРОМ
ENetrebin (обсуждение | вклад) |
ENetrebin (обсуждение | вклад) |
||
| Строка 3: | Строка 3: | ||
Запрос создает <code>application/json</code>полезную нагрузку. | Запрос создает <code>application/json</code>полезную нагрузку. | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan=" | | rowspan="2" |GET | ||
|Managed | |Managed | ||
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/events/{eventId}</nowiki></code> | |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/events/{eventId}</nowiki></code> | ||
|- | |- | ||
| | |Среда АктивногоШлюза | ||
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/events/{eventId}</nowiki></code> | |<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/events/{eventId}</nowiki></code> | ||
|} | |} | ||
Версия 18:34, 15 февраля 2023
Перечисляет параметры указанного события.
Запрос создает application/jsonполезную нагрузку.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v1/events/{eventId}
|
| Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v1/events/{eventId}
|
Аутентификация
Чтобы выполнить этот запрос , вам необходимо разрешение на проблему с доступом и канал событий, метрики и топологию ( DataExport) , назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | В | Необходимость |
|---|---|---|---|---|
| eventId | string | ID требуемого события. | path | требуется |
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 200 | EventRestEntry | Успех |
Объекты тела ответа
Объект _ EventRestEntry
Набор параметров события.
Помимо общих свойств, упомянутых здесь, которые есть у каждого события, фактическое событие имеет набор метаданных, которые различаются в зависимости от типа события.
| Элемент | Тип | Описание |
|---|---|---|
| startTime | integer | Отметка времени обнаружения события в миллисекундах UTC.
Может быть |
| endTime | integer | Отметка времени закрытия события в миллисекундах UTC.
Может быть |
| entityId | string | Идентификатор затронутого объекта Ключ-АСТРОМ.
Может быть |
| entityName | string | Имя затронутого объекта Ключ-АСТРОМ.
Может быть |
| severityLevel | string | Тяжесть события.
Элемент может содержать эти значения
Может быть |
| impactLevel | string | Уровень воздействия события. Он показывает, на что влияет проблема: на инфраструктуру, службу или приложение.
Элемент может содержать эти значения
Может быть |
| eventType | string | Тип события.
Элемент может содержать эти значения
Может быть |
| resourceId | string | Идентификатор ресурса, на котором произошло событие.
Может быть |
| resourceName | string | Имя ресурса, на котором произошло событие.
Может быть |
| eventStatus | string | Состояние мероприятия: открытое или закрытое.
Элемент может содержать эти значения
Может быть |
| tags | TagInfo[] | Теги объекта Ключ-АСТРОМ, вызвавшего событие.
Может быть |
| id | string | Закодированный идентификатор события. Формат — eventID_startTime .
Вы должны использовать значение из этого поля, когда вам нужен идентификатор события. Может быть |
Объект _ TagInfo
Тег сущности Ключ-АСТРОМ.
| Элемент | Тип | Описание |
|---|---|---|
| context | string | Происхождение тега, например AWS или Cloud Foundry.
Пользовательские теги используют это Элемент может содержать эти значения
|
| key | string | Ключ тега.
Пользовательские теги имеют значение тега здесь. |
| value | string | Значение тега.
Не применимо к пользовательским тегам. Может быть |
JSON-модель тела ответа
{
"startTime": 1521042929000,
"endTime": 1521542929000,
"entityId": "HOST-0000000000000007",
"entityName": "Example Host",
"severityLevel": "PERFORMANCE",
"impactLevel": "INFRASTRUCTURE",
"eventType": "SLOW_DISK",
"eventStatus": "OPEN",
"tags": [
{
"context": "CONTEXTLESS",
"key": "exampleTag"
}
],
"id": "5915682011263205071_1521042929000",
"source": "builtin"
}
Пример
В этом примере запрос запрашивает параметры события с идентификатором 4166694657638834567_1533134704285 .
Это служба, на которую влияет событие CUSTOM_DEPLOYMENT , и она помечена пользовательским тегом развертывания .
Маркер API передается в заголовке авторизации .
Curl
curl -X GET \
https://mySampleEnv.live.dynatrace.com/api/v1/events/4166694657638834567_1533134704285 \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL-адрес запроса
https://mySampleEnv.live.dynatrace.com/api/v1/events/4166694657638834567_1533134704285
Содержание ответа
{
"eventId": 4166694657638834567,
"startTime": 1533134704285,
"endTime": 1533134704285,
"entityId": "SERVICE-0F579DCA105F190C",
"entityName": "wmqiTestingWeb",
"severityLevel": null,
"impactLevel": "SERVICE",
"eventType": "CUSTOM_DEPLOYMENT",
"eventStatus": "CLOSED",
"tags": [
{
"context": "CONTEXTLESS",
"key": "deploy"
}
],
"id": "4166694657638834567_1533134704285",
"customProperties": {
"Build Number": "1.223.23432",
"Owner": "Jason Miller (jason.miller@easytravel.com)",
"Approver": "Alice McBright (alice.mcbright@easytravel.com)",
"Git commit": "e5afbftc7eb"
},
"deploymentProject": "easyTravel service",
"remediationAction": "http://tower.local/job/RemediateJob/38/",
"deploymentVersion": "1.23.321",
"deploymentName": "easyTravel service deployment",
"source": "ServiceNow",
"ciBackLink": "http://tower.local/job/DeployJob/38/artifact/build/Deployment-v1.23.321.zip"
}
Код ответа
200
