ENetrebin: Новая страница: «'''''API Ключ-АСТРОМ / API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B|Эндп...»

2024-06-06T19:02:53Z

Новая страница: «'''''API Ключ-АСТРОМ / API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B|Эндп...»

Новая страница

'''''[[API Ключ-АСТРОМ]] / [[API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B|Эндпойнты среды]] / [[API Ключ-АСТРОМ#.D0.A0.D0.B0.D0.B7.D0.B2.D1.91.D1.80.D1.82.D1.8B.D0.B2.D0.B0.D0.BD.D0.B8.D0.B5|Развёртывание]] / События v2 / GET списка событий'''''

Список событий, произошедших в указанный период времени, вместе с их свойствами.

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

Этот запрос является выпуском Early Adopter и может быть изменен несовместимым образом.
{| class="wikitable"
| rowspan="2" |GET
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/events</nowiki></code>
|-
|Среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/events</nowiki></code>
|}
==Аутентификация==
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия '''Чтение событий''' ( <code>events.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .
==Параметры==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|nextPageKey
|string
|Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.
Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey .

Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса.
|запрос
|необязательный
|-
|pageSize
|integer
|Количество событий в полезной нагрузке одного ответа.
Максимально допустимый размер страницы — 1000.

Если не установлено, используется 100.
|запрос
|необязательный
|-
|from
|string
|Начало запрошенного таймфрейма.
Вы можете использовать один из следующих форматов:
*Отметка времени в миллисекундах UTC.
*Человекочитаемый формат <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>m</code>: минут
**<code>h</code>: часы
**<code>d</code>: дней
**<code>w</code>: недели
**<code>M</code>: месяцы
**<code>y</code>: годы
Если не установлено, используется относительный таймфрейм в два часа ( <code>now-2h</code>).
|запрос
|необязательный
|-
|to
|string
|Конец запрошенного периода времени.
Вы можете использовать один из следующих форматов:
*Отметка времени в миллисекундах UTC.
*Человекочитаемый формат <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>m</code>: минут
**<code>h</code>: часы
**<code>d</code>: дней
**<code>w</code>: недели
**<code>M</code>: месяцы
**<code>y</code>: годы
Если не установлено, используется текущая метка времени.
|запрос
|необязательный
|-
|eventSelector
|string
|Определяет область запроса. В ответ включаются только события, соответствующие указанным критериям.
Вы можете добавить один или несколько из перечисленных ниже критериев. Для каждого критерия можно указать несколько значений, разделенных запятыми, если не указано иное. Если указано несколько значений, применяется логика ИЛИ .
*Идентификатор события: <code>eventId("id-1", "id-2")</code>.
*ID связанного объекта: <code>entityId("id-1", "id-2")</code>.
*Статус события: <code>status("OPEN")</code>или <code>status("CLOSED")</code>. Вы можете указать только один статус.
*Идентификатор зоны управления: <code>managementZoneId("123", "321")</code>.
*Тип события: <code>eventType("event-type")</code>. Вы можете указать только один тип события. Вы можете получить список возможных типов событий с помощью вызова типов событий GET .
*Идентификатор корреляции: <code>correlationId("id-1", "id-2")</code>.
*Произошло во время технического обслуживания (правда, ложь): <code>underMaintenance(true)</code>.
*Уведомления подавляются (true, false): <code>suppressAlert(true)</code>.
*Создание проблемы подавляется (true, false): <code>suppressProblem(true)</code>.
*Частое событие (истина, ложь): <code>frequentEvent(true)</code>.
*Свойство события: <code>property.<key>("value-1", "value-2")</code>.
Чтобы задать несколько критериев, разделите их запятыми ( <code>,</code>). В ответ включаются только результаты, соответствующие всем критериям.
|запрос
|необязательный
|-
|entitySelector
|string
|Область сущности запроса. Вы должны установить один из этих критериев:
*Тип объекта:<code>type("TYPE")</code>
*Идентификатор объекта Ключ-АСТРОМ: <code>entityId("id")</code>. Вы можете указать несколько идентификаторов, разделенных запятой ( <code>entityId("id-1","id-2")</code>). Все запрошенные сущности должны быть одного типа.
Вы можете добавить один или несколько следующих критериев. Значения чувствительны к регистру, и <code>EQUALS</code>оператор используется, если не указано иное.
*Тег: <code>tag("value")</code>. Теги в форматах <code>[context]key:value</code>, <code>key:value</code>и <code>value</code>обнаруживаются и анализируются автоматически. Любые двоеточия ( <code>:</code>), которые являются частью ключа или значения, должны быть экранированы обратной косой чертой ( <code>\</code>), в противном случае она будет интерпретироваться как разделитель между ключом и значением. Все значения тегов чувствительны к регистру.
*Идентификатор зоны управления:<code>mzId(123)</code>
*Название зоны управления:<code>mzName("value")</code>
*Имя объекта: <code>entityName("value")</code>. По умолчанию это фильтрует объекты, имя которых содержит заданное значение и не чувствительно к регистру. Доступны следующие модификации:
**<code>entityName.equals</code>: изменяет оператор на <code>EQUALS</code>.
**<code>entityName.startsWith</code>: изменяет оператор на <code>BEGINS WITH</code>.
**<code>entityName.in</code>: позволяет указать несколько значений. Оператор <code>EQUALS</code>обращается.
**<code>caseSensitive(entityName("value"))</code>: принимает любой критерий имени сущности в качестве аргументов и делает значение чувствительным к регистру.
*Состояние здоровья (ЗДОРОВЫЙ, НЕЗДОРОВЫЙ):<code>healthState("HEALTHY")</code>
*Отметка времени первого увиденного: <code>firstSeenTms.<operator>(now-3h)</code>. Используйте любой формат метки времени из параметров from / to . Доступны следующие операторы:
**<code>lte</code>: раньше или в указанное время
**<code>lt</code>: раньше указанного времени
**<code>gte</code>: позже или в указанное время
**<code>gt</code>: позже указанного времени
*Атрибут объекта: <code><attribute>("value1","value2")</code>и <code><attribute>.exists()</code>. Чтобы получить список доступных атрибутов, выполните запрос типа сущности GET и проверьте поле свойств ответа.
*Отношения: <code>fromRelationships.<relationshipName>()</code>и <code>toRelationships.<relationshipName>()</code>. Критерий принимает селектор объектов в качестве атрибута. Чтобы получить список доступных отношений, выполните запрос типа объекта GET и проверьте поля fromRelationships и toRelationships .
*Отрицание: <code>not(<criterion>)</code>. Инвертирует любой критерий, кроме type .
Дополнительные сведения см. в разделе Селектор объектов в документации Ключ-АСТРОМ.

Чтобы задать несколько критериев, разделите их запятой ( <code>,</code>). Например, <code>type("HOST"),healthState("HEALTHY")</code>. В ответ включаются только результаты, соответствующие всем критериям.

Длина строки ограничена 10 000 символов.

Количество объектов, которые можно выбрать, ограничено 10000.
|запрос
|необязательный
|}
==Ответ==
===Коды ответов===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|EventList
|Успех. Ответ содержит список событий.
|}
===Объекты тела ответа===
====Объект <code>EventList</code>====
Список событий.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|warnings
|string[]
|Список предупреждений.
Может быть <code>null</code>.
|-
|events
|Event[]
|Список событий.
Может быть <code>null</code>.
|-
|pageSize
|integer
|Количество записей на странице.
Может быть <code>null</code>.
|-
|nextPageKey
|string
|Курсор для следующей страницы результатов. Имеет значение <code>null</code>на последней странице.
Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.

Может быть <code>null</code>.
|-
|totalCount
|integer
|Общее количество записей в результате.
|}
====Объект <code>Event</code>====
Конфигурация события.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|eventType
|string
|Тип события.
Может быть <code>null</code>.
|-
|entityId
|EntityStub
|Краткое представление отслеживаемого объекта.
Может быть <code>null</code>.
|-
|entityTags
|METag[]
|Список тегов связанного объекта.
Может быть <code>null</code>.
|-
|underMaintenance
|boolean
|Если <code>true</code>, событие произошло, когда отслеживаемая система находилась на обслуживании.
Может быть <code>null</code>.
|-
|suppressAlert
|boolean
|Состояние предупреждения во время технического обслуживания :
*<code>false</code>: Оповещение работает как обычно.
*<code>true</code>: Оповещение отключено.
Может быть <code>null</code>.
|-
|suppressProblem
|boolean
|Статус обнаружения проблемы во время технического обслуживания :
*<code>false</code>: Обнаружение проблем работает как обычно.
*<code>true</code>: обнаружение проблем отключено.
Может быть <code>null</code>.
|-
|frequentEvent
|boolean
|Если <code>true</code>, событие происходит часто .
Частое событие не вызывает проблем.

Может быть <code>null</code>.
|-
|managementZones
|ManagementZone[]
|Список всех зон управления, которым принадлежит событие.
Может быть <code>null</code>.
|-
|eventId
|string
|Идентификатор события.
Может быть <code>null</code>.
|-
|properties
|EventProperty[]
|Список свойств события.
Может быть <code>null</code>.
|-
|status
|string
|Статус события.
Элемент может содержать эти значения
*<code>CLOSED</code>
*<code>OPEN</code>
Может быть <code>null</code>.
|-
|startTime
|integer
|Отметка времени возникновения события в миллисекундах UTC.
Может быть <code>null</code>.
|-
|endTime
|integer
|Отметка времени закрытия события в миллисекундах UTC.
Имеет значение, <code>null</code>если событие все еще активно.

Может быть <code>null</code>.
|-
|title
|string
|Название события.
Может быть <code>null</code>.
|-
|correlationId
|string
|Идентификатор корреляции события.
Может быть <code>null</code>.
|}
====Объект <code>EntityStub</code>====
Краткое представление отслеживаемого объекта.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|entityId
|EntityId
|Краткое представление отслеживаемого объекта.
Может быть <code>null</code>.
|-
|name
|string
|Имя сущности.
Не включается в ответ, если сущность с соответствующим идентификатором не найдена.

Может быть <code>null</code>.
|}
====Объект <code>EntityId</code>====
Краткое представление отслеживаемого объекта.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|id
|string
|Идентификатор сущности.
Может быть <code>null</code>.
|-
|type
|string
|Тип сущности.
Может быть <code>null</code>.
|}
====Объект <code>METag</code>====
Тег отслеживаемого объекта.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|stringRepresentation
|string
|Строковое представление тега.
Может быть <code>null</code>.
|-
|value
|string
|Значение тега.
Может быть <code>null</code>.
|-
|key
|string
|Ключ тега.
Может быть <code>null</code>.
|-
|context
|string
|Происхождение тега, например AWS или Cloud Foundry.
Пользовательские теги используют это <code>CONTEXTLESS</code>значение.

Может быть <code>null</code>.
|}
====Объект <code>ManagementZone</code>====
Краткое представление зоны управления.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|name
|string
|Имя зоны управления.
Может быть <code>null</code>.
|-
|id
|string
|Идентификатор зоны управления.
Может быть <code>null</code>.
|}
====Объект <code>EventProperty</code>====
Свойство события.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|value
|string
|Значение свойства события.
Может быть <code>null</code>.
|-
|key
|string
|Ключ свойства события.
Может быть <code>null</code>.
|}
===JSON-модель тела ответа===
<code>{
"warnings": [
"string"
],
"events": [
{
"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"
}
],
"pageSize": 1,
"nextPageKey": "AQAAABQBAAAABQ==",
"totalCount": 1
}</code>
==Пример==
В этом примере в запросе перечислены все события PROCESS_RESTART ( <code>eventSelector=eventType("PROCESS_RESTART")</code>), произошедшие за последние 2 часа ( <code>from=now-2h</code>), когда окно обслуживания было активным ( <code>eventSelector=underMaintenance(true)</code>). Результат усекается до двух событий.

Маркер API передается в заголовке авторизации .
====Curl====
<code>curl --request GET \
--url '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events?eventSelector=eventType(%22PROCESS_RESTART%22)%2CunderMaintenance(true)&from=now-2h'</nowiki> \
--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
====URL-адрес запроса====
<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/events?eventSelector=eventType(%22PROCESS_RESTART%22)%2CunderMaintenance(true)&from=now-2h</nowiki></code>
====Тело ответа====
<code>{
"totalCount": 43,
"pageSize": 100,
"events": [
{
"eventId": "-6475311485380369979_1628500180000",
"startTime": 1628500180000,
"endTime": 1628500240000,
"eventType": "PROCESS_RESTART",
"title": "Process restart",
"entityId": {
"entityId": {
"id": "PROCESS_GROUP_INSTANCE-03F98EA8639FD052",
"type": "PROCESS_GROUP_INSTANCE"
},
"name": "IIS app pool dotNetFrontend_easyTravel_x64"
},
"properties": [
{
"key": "dt.event.group_label",
"value": "Process restart"
}
],
"status": "OPEN",
"entityTags": [
{
"context": "CONTEXTLESS",
"key": "easyTravel",
"stringRepresentation": "easyTravel"
},
{
"context": "CONTEXTLESS",
"key": "tech",
"value": "IIS",
"stringRepresentation": "tech:IIS"
},
{
"context": "CONTEXTLESS",
"key": "tech",
"value": ".NET",
"stringRepresentation": "tech:.NET"
},
{
"context": "CONTEXTLESS",
"key": "hosts",
"value": "w-077",
"stringRepresentation": "hosts:w-077"
},
{
"context": "CONTEXTLESS",
"key": "Infrastructure",
"value": "Windows",
"stringRepresentation": "Infrastructure:Windows"
},
{
"context": "CONTEXTLESS",
"key": "dotNetFrontend",
"stringRepresentation": "dotNetFrontend"
},
],
"managementZones": [
{
"id": "9130632296508575249",
"name": "Easytravel"
},
{
"id": "-6239538939987181652",
"name": "frontend"
},
{
"id": "5130731705740636866",
"name": "Windows"
}
],
"underMaintenance": true,
"suppressAlert": true,
"suppressProblem": true,
"frequentEvent": false
},
{
"eventId": "-231290298591263162_1628500000000",
"startTime": 1628500000000,
"endTime": 1628500060000,
"eventType": "PROCESS_RESTART",
"title": "Process restart",
"entityId": {
"entityId": {
"id": "PROCESS_GROUP_INSTANCE-00CA9B0F1AE9BAF8",
"type": "PROCESS_GROUP_INSTANCE"
},
"name": "chromedriver_linux64"
},
"properties": [
{
"key": "dt.event.group_label",
"value": "Process restart"
}
],
"status": "CLOSED",
"entityTags": [
{
"context": "CONTEXTLESS",
"key": "Infrastructure",
"value": "Linux",
"stringRepresentation": "Infrastructure:Linux"
},
{
"context": "CONTEXTLESS",
"key": "hosts",
"value": "l-008",
"stringRepresentation": "hosts:l-008"
}
],
"managementZones": [
{
"id": "2631544906797876001",
"name": "Linux"
}
],
"underMaintenance": true,
"suppressAlert": false,
"suppressProblem": false,
"frequentEvent": false
}
],
"warnings": []
}</code>
====Код ответа====
200

GET списка событий - История изменений

ENetrebin: Новая страница: «'''''API Ключ-АСТРОМ / API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B|Эндп...»