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

Материал из Dynatrace
(Новая страница: «Данная функция извлекает указанную запись журнала аудита. {| class="wikitable" | rowspan="3" |GET |Managed |<cod...»)
 
 
(не показаны 3 промежуточные версии 2 участников)
Строка 6: Строка 6:
|-
|-
|SaaS
|SaaS
|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/auditlogs/{id}</nowiki></code>
|<code><nowiki>https://{your-environment-id}.live.{server-name}.com/api/v2/auditlogs/{id}</nowiki></code>
|-
|-
|Environment АктивныйШлюз
|Environment АктивныйШлюз
Строка 13: Строка 13:


== Аутентификация ==
== Аутентификация ==
Чтобы выполнить этот запрос, вам необходимо разрешение на чтение журналов аудита ( <code>auditLogs.read</code>) , назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Чтобы выполнить этот запрос, вам необходимо разрешение на чтение журналов аудита ( <code>auditLogs.read</code>) , назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .


== Параметры ==
== Параметры ==
Строка 69: Строка 69:


Элемент может содержать эти значения
Элемент может содержать эти значения
* <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
|category
Строка 75: Строка 91:


Элемент может содержать эти значения
Элемент может содержать эти значения
* <code>CONFIG</code>
* <code>DEBUG_UI</code>
* <code>MANUAL_TAGGING_SERVICE</code>
* <code>TOKEN</code>
* <code>WEB_UI</code>
|-
|-
|entityId
|entityId
Строка 154: Строка 176:
   ]
   ]
  }</code>
  }</code>
== Пример ==
В этом примере запрос получает запись журнала аудита с идентификатором 157607396300050000 .
В этой записи хранится информация об изменении конфигурации дашборда с идентификатором 14b3bfe7-69d8-48bf-b08a-4f9a2ff3f703 . Изменение представляет собой изменение положения и размера плитки, выполненное пользователем Dynatrace с идентификатором пользователя 643541629 .
Маркер API передается в заголовке авторизации .
==== Curl ====
<code>curl -X GET \
  '<nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/auditlogs/157607396300050000'</nowiki> \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
==== URL-адрес запроса ====
<code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/auditlogs/157607396300050000</nowiki></code>
==== Тело ответа ====
<code>{
  "logId": "157607396300050000",
  "eventType": "UPDATE",
  "category": "CONFIG",
  "entityId": "DASHBOARDS_SETTINGS: 14b3bfe7-69d8-48bf-b08a-4f9a2ff3f703",
  "environmentId": "yasmuoujsw",
  "user": "Dynatrace user #643541629",
  "userType": "USER_NAME",
  "userOrigin": "webui (240.204.62.255)",
  "timestamp": 1576074315483,
  "success": true,
  "patch": [
    {
      "op": "replace",
      "path": "/tiles/24/top",
      "value": 304,
      "oldValue": 380
    },
    {
      "op": "replace",
      "path": "/tiles/24/left",
      "value": 304,
      "oldValue": 798
    },
    {
      "op": "replace",
      "path": "/tiles/24/width",
      "value": 608,
      "oldValue": 304
    },
    {
      "op": "replace",
      "path": "/tiles/24/height",
      "value": 608,
      "oldValue": 304
    }
  ]
}</code>
==== Код ответа ====
200

Текущая версия на 14:48, 24 января 2023

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

GET Managed https://{your-domain}/e/{your-environment-id}/api/v2/auditlogs/{id}
SaaS https://{your-environment-id}.live.{server-name}.com/api/v2/auditlogs/{id}
Environment АктивныйШлюз https://{your-activegate-domain}/e/{your-environment-id}/api/v2/auditlogs/{id}

Аутентификация

Чтобы выполнить этот запрос, вам необходимо разрешение на чтение журналов аудита ( auditLogs.read) , назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Параметр Тип Описание В Необходимость
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 Идентификатор среды Dynatrace, в которой произошла записанная операция.
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
    }
  ]
}
Источник — https://doc.expert-apm.kz/index.php?title=Получение_записи_лога_аудита&oldid=2831