GET запись лога аудита
API Ключ-АСТРОМ / Эндпойнты среды / Логи аудита / GET запись лога аудита
Данная функция извлекает указанную запись журнала аудита.
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/auditlogs/{id}
|
Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/auditlogs/{id}
|
Аутентификация
Чтобы выполнить этот запрос, вам необходимо разрешение на чтение журналов аудита ( auditLogs.read
) , назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
Параметр | Тип | Описание | in | Необходимость |
---|---|---|---|---|
id | string | id необходимой записи журнала. | path | требуется |
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
200 | AuditLogEntry | Успех |
400 | ErrorEnvelope | Не удалось. Недопустимый формат ID. |
404 | ErrorEnvelope | Не удалось. Запрошенный ресурс не существует. |
Объекты тела ответа
Объект AuditLogEntry
Запись журнала аудита.
Элемент | Тип | Описание |
---|---|---|
logId | string | Идентификатор записи журнала. |
eventType | string | Тип записываемой операции.
Элемент может содержать эти значения
|
category | string | Категория записываемой операции.
Элемент может содержать эти значения
|
entityId | string | ID объекта из категории .
Например, это может быть идентификатор конфигурации для Может быть |
environmentId | string | Идентификатор среды Ключ-АСТРОМ, в которой произошла записанная операция. |
user | string | ID пользователя, выполнившего записанную операцию. |
userType | string | Тип аутентификации пользователя .
Элемент может содержать эти значения
|
userOrigin | string | Происхождение и IP-адрес пользователя .
Может быть |
timestamp | integer | Отметка времени создания записи в миллисекундах UTC. |
success | boolean | Записанная операция выполнена успешно ( true ) или неудачно ( false ).
|
message | string | Зарегистрированное сообщение.
Может быть |
patch | object | Патч записанной операции в виде JSON-представления.
Формат представляет собой расширенный RFC 6902. Патч также содержит предыдущее значение в поле oldValue . Может быть |
JSON-модель тела ответа
{
"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
}
]
}