GET запись лога аудита: различия между версиями

Текущая версия от 21:00, 25 декабря 2024

API АппОптима / Эндпойнты среды / Логи аудита / GET запись лога аудита

Данная функция извлекает указанную запись журнала аудита.

GET	АппОптима	`https://{your-domain}/e/{your-environment-id}/api/v2/auditlogs/{id}`
GET	Среда АктивногоШлюза	`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	Тип записываемой операции. Элемент может содержать эти значения `CREATE` `DELETE` `GENERAL` `GET` `LOGIN` `LOGOUT` `PATCH` `POST` `PUT` `READ` `REVOKE` `TAG_ADD` `TAG_REMOVE` `TAG_UPDATE` `UPDATE`
category	string	Категория записываемой операции. Элемент может содержать эти значения `CONFIG` `DEBUG_UI` `MANUAL_TAGGING_SERVICE` `TOKEN` `WEB_UI`
entityId	string	ID объекта из категории . Например, это может быть идентификатор конфигурации для `CONFIG`категории или идентификатор токена для `TOKEN`категории. Может быть `null`.
environmentId	string	Идентификатор среды АппОптима, в которой произошла записанная операция.
user	string	ID пользователя, выполнившего записанную операцию.
userType	string	Тип аутентификации пользователя . Элемент может содержать эти значения `PUBLIC_TOKEN_IDENTIFIER` `REQUEST_ID` `SERVICE_NAME` `TOKEN_HASH` `USER_NAME`
userOrigin	string	Происхождение и IP-адрес пользователя . Может быть `null`.
timestamp	integer	Отметка времени создания записи в миллисекундах UTC.
success	boolean	Записанная операция выполнена успешно ( `true`) или неудачно ( `false`).
message	string	Зарегистрированное сообщение. Может быть `null`.
patch	object	Патч записанной операции в виде JSON-представления. Формат представляет собой расширенный RFC 6902. Патч также содержит предыдущее значение в поле oldValue . Может быть `null`.

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
    }
  ]
}

@@ Строка 1: / Строка 1: @@
+'''''[[API АппОптима]] / [[API АппОптима|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%BF%D0%BE%20%D0%B1%D0%B5%D0%B7%D0%BE%D0%BF%D0%B0%D1%81%D0%BD%D0%BE%D1%81%D1%82%D0%B8%20%D0%98%D0%98-,%D0%9B%D0%BE%D0%B3%D0%B8%20%D0%B0%D1%83%D0%B4%D0%B8%D1%82%D0%B0,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Логи аудита] / GET запись лога аудита'''''
 Данная функция извлекает указанную запись журнала аудита.
 {| class="wikitable"
 | rowspan="2" |GET
-|Managed
+|АппОптима
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/auditlogs/{id}</nowiki></code>
 |-
@@ Строка 96: / Строка 97: @@
 |environmentId
 |string
-|Идентификатор среды Ключ-АСТРОМ, в которой произошла записанная операция.
+|Идентификатор среды АппОптима, в которой произошла записанная операция.
 |-
 |user
@@ Строка 138: / Строка 139: @@
 |}
 ===JSON-модель тела ответа===
-  <code>{
+  <{
     "logId": "197425568800060000",
     "eventType": "UPDATE",
@@ Строка 157: / Строка 158: @@
       }
     ]
-  }</code>
+  }