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

IKuznetsov в 21:00, 25 декабря 2024

2024-12-25T21:00:52Z

IKuznetsov в 14:13, 24 декабря 2024

2024-12-24T14:13:05Z

IKuznetsov в 12:21, 24 декабря 2024

2024-12-24T12:21:03Z

ENetrebin в 16:23, 5 июня 2024

2024-06-05T16:23:59Z

ENetrebin: Новая страница: « Данная функция извлекает указанную запись журнала аудита. {| class="wikitable" | rowspan="2" |GET |Managed |
2024-06-04T03:49:04Z

Новая страница: « Данная функция извлекает указанную запись журнала аудита. {| class="wikitable" | rowspan="2" |GET |Managed |<c...»

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

Данная функция извлекает указанную запись журнала аудита.
{| class="wikitable"
| rowspan="2" |GET
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/auditlogs/{id}</nowiki></code>
|-
|Среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/auditlogs/{id}</nowiki></code>
|}
==Аутентификация==
Чтобы выполнить этот запрос, вам необходимо разрешение на чтение журналов аудита ( <code>auditLogs.read</code>) , назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .
==Параметры==
{| class="wikitable"
!Параметр
!Тип
!Описание
!in
!Необходимость
|-
|id
|string
|id необходимой записи журнала.
|path
|требуется
|}
==Ответ==
===Коды ответов===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|AuditLogEntry
|Успех
|-
|400
|ErrorEnvelope
|Не удалось. Недопустимый формат ID.
|-
|404
|ErrorEnvelope
|Не удалось. Запрошенный ресурс не существует.
|}
===Объекты тела ответа===
====Объект <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
|ID пользователя, выполнившего записанную операцию.
|-
|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>{
"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>