GET события v2

API АппОптима / Эндпойнты среды / Развёртывание / События v2 / GET события v2

Получает все свойства указанного события.

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

Первых компаний, внедривших

Этот запрос является выпуском Early Adopter и может быть изменен несовместимым образом.

GET	АппОптима	https://{your-domain}/e/{your-environment-id}/api/v2/events/{eventId}
	Среда АктивногоШлюза	https://{your-activegate-domain}/e/{your-environment-id}/api/v2/events/{eventId}

Аутентификация

Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение событий ( events.read​​) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Параметр	Тип	Описание	In	Необходимый
eventId	string	ID требуемого события.	path	обязательный

Ответ

Коды ответов

Код	Тип	Описание
200	Event	Успех. Ответ содержит конфигурацию события.

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

Объект Event

Конфигурация события.

Элемент	Тип	Описание
eventType	string	Тип события. Может быть null.
entityId	EntityStub	Краткое представление отслеживаемого объекта. Может быть null.
entityTags	METag[]	Список тегов связанного объекта. Может быть null.
underMaintenance	boolean	Если true, событие произошло, когда отслеживаемая система находилась на обслуживании. Может быть null.
suppressAlert	boolean	Состояние предупреждения во время технического обслуживания : false: Оповещение работает как обычно. true: Оповещение отключено. Может быть null.
suppressProblem	boolean	Статус обнаружения проблемы во время технического обслуживания : false: Обнаружение проблем работает как обычно. true: обнаружение проблем отключено. Может быть null.
frequentEvent	boolean	Если true, событие происходит часто . Частое событие не вызывает проблем. Может быть null.
managementZones	ManagementZone[]	Список всех зон управления, которым принадлежит событие. Может быть null.
eventId	string	Идентификатор события. Может быть null.
properties	EventProperty[]	Список свойств события. Может быть null.
статус	string	Статус события. Элемент может содержать эти значения Может быть null.
startTime	integer	Отметка времени возникновения события в миллисекундах UTC. Может быть null.
endTime	integer	Отметка времени закрытия события в миллисекундах UTC. Имеет значение, nullесли событие все еще активно. Может быть null.
title	string	Название события. Может быть null.
correlationId	string	Идентификатор корреляции события. Может быть null.

Объект EntityStub

Краткое представление отслеживаемого объекта.

Элемент	Тип	Описание
entityId	EntityId	Краткое представление отслеживаемого объекта. Может быть null.
name	string	Имя сущности. Не включается в ответ, если сущность с соответствующим идентификатором не найдена. Может быть null.

Объект EntityId

Краткое представление отслеживаемого объекта.

Элемент	Тип	Описание
id	string	Идентификатор сущности. Может быть null.
type	string	Тип сущности. Может быть null.

Объект METag

Тег отслеживаемого объекта.

Элемент	Тип	Описание
stringRepresentation	string	Строковое представление тега. Может быть null.
value	string	Значение тега. Может быть null.
key	string	Ключ тега. Может быть null.
context	string	Происхождение тега, например AWS или Cloud Foundry. Пользовательские теги используют это CONTEXTLESSзначение. Может быть null.

Объект ManagementZone

Краткое представление зоны управления.

Элемент	Тип	Описание
name	string	Имя зоны управления. Может быть null.
id	string	Идентификатор зоны управления. Может быть null.

Объект EventProperty

Свойство события.

Элемент	Тип	Описание
value	string	Значение свойства события. Может быть null.
key	string	Ключ свойства события. Может быть null.

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

<{
  "eventType": "LOW_DISK_SPACE",
  "entityId": {
    "entityId": {
      "id": "string",
      "type": "string"
    },
    "name": "string"
  },
  "entityTags": [
    {
      "stringRepresentation": "string",
      "value": "string",
      "key": "string",
      "context": "string"
    }
  ],
  "underMaintenance": true,
  "suppressAlert": true,
  "suppressProblem": true,
  "frequentEvent": true,
  "managementZones": [
    {
      "name": "string",
      "id": "string"
    }
  ],
  "eventId": "4293884258445543163_1564039524182",
  "properties": [
    {
      "value": "string",
      "key": "string"
    }
  ],
  "status": "OPEN",
  "startTime": 1564039524182,
  "endTime": 1564039524182,
  "title": "High CPU load on host X",
  "correlationId": "933613657e1c8fcf"
}

Пример

В этом примере запрос запрашивает параметры события с идентификатором 6375436663535938547_1628496488654 .

Это событие SYNTHETIC_GLOBAL_OUTAGE , указывающее на глобальное отключение мониторов браузера.

Маркер API передается в заголовке авторизации .

Curl

<curl --request GET \
  --url https://mySampleEnv.live.ruscomtech.ru/api/v2/events/6375436663535938547_1628496488654 \
  --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

URL-адрес запроса

https://mySampleEnv.live.ruscomtech.ru/api/v2/events/6375436663535938547_1628496488654

Тело ответа

<{
  "eventId": "6375436663535938547_1628496488654",
  "startTime": 1628496488654,
  "endTime": 1628503679796,
  "eventType": "SYNTHETIC_GLOBAL_OUTAGE",
  "title": "Browser monitor global outage",
  "entityId": {
    "entityId": {
      "id": "SYNTHETIC_TEST-03ABB7F6446D1727",
      "type": "SYNTHETIC_TEST"
    },
    "name": "Maintenance window test"
  },
  "properties": [
    {
      "key": "dt.event.group_label",
      "value": "Browser monitor global outage"
    },
    {
      "key": "dt.event.is_rootcause_relevant",
      "value": "true"
    }
  ],
  "status": "CLOSED",
  "correlationId": "aecd1653df38ef50",
  "entityTags": [
    {
      "context": "CONTEXTLESS",
      "key": "Synthetic",
      "value": "Browser",
      "stringRepresentation": "Synthetic:Browser"
    }
  ],
  "managementZones": [
    {
      "id": "-7832237287622819191",
      "name": "Synthetic tests"
    }
  ],
  "underMaintenance": true,
  "suppressAlert": false,
  "suppressProblem": false,
  "frequentEvent": false
}

Код ответа

200