GET лога аудита - История изменений

ENetrebin в 14:47, 24 января 2023

2023-01-24T14:47:32Z

← Предыдущая		Версия 14:47, 24 января 2023
Строка 1:		Строка 1:
	'''''[[API Ключ-АСТРОМ]] / [https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B_.D1.81.D1.80.D0.B5.D0.B4.D1.8B Эндпойнты среды] / [https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C#.D0.9B.D0.BE.D0.B3.D0.B8_.D0.B0.D1.83.D0.B4.D0.B8.D1.82.D0.B0 Логи аудита] / GET лога аудита'''''		'''''[[API Ключ-АСТРОМ\|API Dynatrace]] / [https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B_.D1.81.D1.80.D0.B5.D0.B4.D1.8B Эндпойнты среды] / [https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C#.D0.9B.D0.BE.D0.B3.D0.B8_.D0.B0.D1.83.D0.B4.D0.B8.D1.82.D0.B0 Логи аудита] / GET лога аудита'''''

	Данная функция извлекает лог аудита вашей среды ~~Ключ-АСТРОМ~~.		Данная функция извлекает лог аудита вашей среды Dynatrace.

	Полный список может быть длинным, поэтому вы можете сузить его, указав параметры фильтра, такие как теги. См. раздел Параметры для более подробной информации.		Полный список может быть длинным, поэтому вы можете сузить его, указав параметры фильтра, такие как теги. См. раздел Параметры для более подробной информации.
Строка 197:		Строка 197:
	\|environmentId		\|environmentId
	\|string		\|string
	\|Идентификатор среды ~~Ключ-АСТРОМ~~, в которой произошла записанная операция.		\|Идентификатор среды Dynatrace, в которой произошла записанная операция.
	\|-		\|-
	\|user		\|user

ENetrebin в 14:31, 29 декабря 2022

2022-12-29T14:31:03Z

← Предыдущая		Версия 14:31, 29 декабря 2022
Строка 1:		Строка 1:
	[[API Ключ-АСТРОМ]] / [https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B_.D1.81.D1.80.D0.B5.D0.B4.D1.8B Эндпойнты среды] / [https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C#.D0.9B.D0.BE.D0.B3.D0.B8_.D0.B0.D1.83.D0.B4.D0.B8.D1.82.D0.B0 Логи аудита] / GET лога аудита		'''''[[API Ключ-АСТРОМ]] / [https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B_.D1.81.D1.80.D0.B5.D0.B4.D1.8B Эндпойнты среды] / [https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C#.D0.9B.D0.BE.D0.B3.D0.B8_.D0.B0.D1.83.D0.B4.D0.B8.D1.82.D0.B0 Логи аудита] / GET лога аудита'''''

	Данная функция извлекает лог аудита вашей среды Ключ-АСТРОМ.		Данная функция извлекает лог аудита вашей среды Ключ-АСТРОМ.

ENetrebin в 14:30, 29 декабря 2022

2022-12-29T14:30:26Z

← Предыдущая		Версия 14:30, 29 декабря 2022
Строка 1:		Строка 1:
	[[API Ключ-АСТРОМ]] / [https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B_.D1.81.D1.80.D0.B5.D0.B4.D1.8B Эндпойнты среды] / Логи аудита / GET лога аудита		[[API Ключ-АСТРОМ]] / [https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B_.D1.81.D1.80.D0.B5.D0.B4.D1.8B Эндпойнты среды] / [https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C#.D0.9B.D0.BE.D0.B3.D0.B8_.D0.B0.D1.83.D0.B4.D0.B8.D1.82.D0.B0 Логи аудита] / GET лога аудита

	Данная функция извлекает лог аудита вашей среды Ключ-АСТРОМ.		Данная функция извлекает лог аудита вашей среды Ключ-АСТРОМ.

ENetrebin: Новая страница: «API Ключ-АСТРОМ / [https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C#.D0.AD.D0.BD.D0.B4.D0.BF.D0...»

2022-12-29T14:29:09Z

Новая страница: «API Ключ-АСТРОМ / [https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C#.D0.AD.D0.BD.D0.B4.D0.BF.D0...»

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

[[API Ключ-АСТРОМ]] / [https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B_.D1.81.D1.80.D0.B5.D0.B4.D1.8B Эндпойнты среды] / Логи аудита / GET лога аудита

Данная функция извлекает лог аудита вашей среды Ключ-АСТРОМ.

Полный список может быть длинным, поэтому вы можете сузить его, указав параметры фильтра, такие как теги. См. раздел Параметры для более подробной информации.

Вы можете ограничить вывод, используя нумерацию страниц:
#Укажите количество результатов на странице в параметре запроса pageSize .
#Затем используйте курсор из поля nextPageKey предыдущего ответа в параметре запроса nextPageKey для получения последующих страниц.
{| class="wikitable"
| rowspan="3" |GET
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/auditlogs</nowiki></code>
|-
|SaaS
|<code><nowiki>https://{your-environment-id}.live.{server-name}.com/api/v2/auditlogs</nowiki></code>
|-
|Среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/auditlogs</nowiki></code>
|}
==Аутентификация==
Чтобы выполнить этот запрос, вам необходимо разрешение на чтение логов аудита ( <code>auditLogs.read</code>) , назначенное вашему токену API . Чтобы узнать, как его получить и использовать, см. раздел [https://doc.ruscomtech.ru/index.php/%D0%A2%D0%BE%D0%BA%D0%B5%D0%BD%D1%8B_%D0%B8_%D0%B0%D1%83%D1%82%D0%B5%D0%BD%D1%82%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%86%D0%B8%D1%8F_(API) Токены и аутентификация] .
==Параметры==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|nextPageKey
|string
|Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.
Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey .

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

Если не установлено, используется 1000.
|запрос
|необязательный
|-
|filter
|string
|Фильтрует лог аудита. Вы можете использовать следующие критерии:
*Пользователь: <code>user("userIdentification")</code>. Обращается оператор <code>EQUALS</code>.
*Тип события: <code>eventType("value")</code>. Обращается оператор <code>EQUALS</code>.
*Категория регистрируемой операции: <code>category("value")</code>. Обращается оператор <code>EQUALS</code>.
*Идентификатор объекта: <code>entityId("id")</code>. Обращается оператор <code>CONTAINS</code>.
Для каждого критерия можно указать несколько альтернатив со значениями, разделенными запятыми. В этом случае применяется логика ИЛИ. Например, <code>eventType("CREATE","UPDATE")</code>означает, что тип события может быть «СОЗДАТЬ» или «ОБНОВИТЬ».

Вы можете указать несколько критериев, разделенных запятыми, например <code>eventType("CREATE","UPDATE"),category("CONFIG")</code>. В ответ включаются только результаты, соответствующие всем критериям.

Укажите значение критерия в виде строки в кавычках. Следующие специальные символы должны быть экранированы тильдой ( <code>~</code>) внутри кавычек:
*Тильда<code>~</code>
*Цитировать<code>"</code>
|запрос
|необязательный
|-
|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-2w</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>: годы
Если не установлено, используется текущая метка времени.
|запрос
|необязательный
|-
|sort
|string
|Сортировка записей лога аудита:
*<code>timestamp</code>: сначала старые.
*<code>-timestamp</code>: сначала новые.
Если не установлено, применяется самая новая первая сортировка.
|запрос
|необязательный
|}
==Ответ==
===Коды ответов===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|Лог аудита
|Успех
|}
===Объекты тела ответа===
====Объект <code>AuditLog</code>====
Лог аудита вашей среды.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|totalCount
|integer
|Общее количество записей в результате.
|-
|pageSize
|integer
|Количество записей на странице.
Может быть <code>null</code>.
|-
|nextPageKey
|string
|Курсор для следующей страницы результатов. Имеет значение <code>null</code>на последней странице.
Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.

Может быть <code>null</code>.
|-
|auditLogs
|AuditLogEntry[]
|Список записей лога аудита, упорядоченных по отметке времени создания.
Может быть <code>null</code>.
|}
====Объект <code>AuditLogEntry</code>====
Запись лога аудита.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|logId
|string
|Идентификатор записи лога.
|-
|eventType
|string
|Тип записываемой операции.
Элемент может содержать эти значения
*<code>CREATE</code>
*<code>DELETE</code>
*<code>GENERAL</code>
*<code>GET</code>
*<code>LOGIN</code>
*<code>LOGOUT</code>
*<code>PATCH</code>
*<code>POST</code>
*<code>PUT</code>
*<code>READ</code>
*<code>REVOKE</code>
*<code>TAG_ADD</code>
*<code>TAG_REMOVE</code>
*<code>TAG_UPDATE</code>
*<code>UPDATE</code>
|-
|category
|string
|Категория записываемой операции.
Элемент может содержать эти значения
*<code>CONFIG</code>
*<code>DEBUG_UI</code>
*<code>MANUAL_TAGGING_SERVICE</code>
*<code>TOKEN</code>
*<code>WEB_UI</code>
|-
|entityId
|string
|ID объекта из категории .
Например, это может быть идентификатор конфигурации для <code>CONFIG</code>категории или идентификатор токена для <code>TOKEN</code>категории.

Может быть <code>null</code>.
|-
|environmentId
|string
|Идентификатор среды Ключ-АСТРОМ, в которой произошла записанная операция.
|-
|user
|string
|Идентификатор пользователя, выполнившего записанную операцию.
|-
|userType
|string
|Тип аутентификации пользователя .
Элемент может содержать эти значения
*<code>PUBLIC_TOKEN_IDENTIFIER</code>
*<code>REQUEST_ID</code>
*<code>SERVICE_NAME</code>
*<code>TOKEN_HASH</code>
*<code>USER_NAME</code>
|-
|userOrigin
|string
|Происхождение и IP-адрес пользователя .
Может быть <code>null</code>.
|-
|timestamp
|integer
|Отметка времени создания записи в миллисекундах UTC.
|-
|success
|boolean
|Записанная операция выполнена успешно ( <code>true</code>) или неудачно ( <code>false</code>).
|-
|message
|string
|Зарегистрированное сообщение.
Может быть <code>null</code>.
|-
|patch
|object
|Патч записанной операции в виде JSON-представления.
Формат представляет собой расширенный <nowiki>RFC 6902</nowiki>. Патч также содержит предыдущее значение в поле oldValue .

Может быть <code>null</code>.
|}
===JSON-модель тела ответа===
<code>{
"totalCount": 10,
"pageSize": 5,
"nextPageKey": "___a7acX3q0AAAAAACJidWlsdGluOnNlcnZpY2lUVEJCUzBaNVIxVjJOSGt6Y3oyLTcwMUZWRkxlclH__9rtpxferQ",
"auditLogs": [
{
"logId": "197425568800060000",
"eventType": "UPDATE",
"category": "CONFIG",
"entityId": "MOBILE_RUM: MOBILE_APPLICATION-752C223D59734CD2",
"environmentId": "prod-env-13",
"user": "test.user@company.com",
"userType": "USER_NAME",
"userOrigin": "webui (192.168.0.2)",
"timestamp": 1974255688445,
"success": true,
"patch": [
{
"op": "replace",
"path": "/refreshTimeIntervalMillis",
"value": 30000,
"oldValue": 20000
}
]
}
]
}</code>
==Пример==
В этом примере запрос извлекает все входы ( <code>filter=eventType(LOGIN)</code>) из лога аудита среды mySampleEnv за последнюю неделю ( <code>from=now-1w</code>).

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

Ответ усекается до первых трех записей.
====Curl====
<code>curl -X GET \
'<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/auditlogs?filter=eventType%28LOGIN%29&from=now-1w'</nowiki> \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
====URL-адрес запроса====
<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/auditlogs?filter=eventType%28LOGIN%29&from=now-1w</nowiki></code>
====Тело ответа====
<code>{
"totalCount": 5820,
"nextPageKey": "vu8y3hPZ3q0AAAAAAi_neQJ8qUAAAAFu0T-ECgAAAW71TAgKAAAD6AAQZXZlbnRUeXBlKExPR0lOKQC-7zLeE9nerQ",
"auditLogs": [
{
"logId": "157607341600050000",
"eventType": "LOGIN",
"category": "WEB_UI",
"entityId": "240.204.62.255",
"environmentId": "yasmuoujsw",
"user": "Astromkey support user #877988415",
"userType": "USER_NAME",
"userOrigin": "Forwarded: 240.204.62.255",
"timestamp": 1576073415531,
"success": true
},
{
"logId": "157607338800050000",
"eventType": "LOGIN",
"category": "WEB_UI",
"entityId": "55.199.177.119",
"environmentId": "yasmuoujsw",
"user": "Astromkey support user #490812376",
"userType": "USER_NAME",
"userOrigin": "Forwarded: 55.199.177.119",
"timestamp": 1576073388150,
"success": true
},
{
"logId": "157607338300060000",
"eventType": "LOGIN",
"category": "WEB_UI",
"entityId": "75.16.11.184",
"environmentId": "umsaywsjuo",
"user": "Astromkey support user #765684830",
"userType": "USER_NAME",
"userOrigin": "Forwarded: 75.16.11.184",
"timestamp": 1576073381543,
"success": true
}
]
}</code>
====Код ответа====
200