Отправка аудит-логов в сервис

Примечание

Отправка аудит-логов в сервис находится на стадии Preview. Чтобы получить возможность отправлять аудит-логи, обратитесь в техническую поддержку.

Перед началом работы

  1. Создайте необходимые типы аудит-событий.

  2. Создайте сервисный аккаунт. В блоке Доступы и роли выберите роли:

    • в блоке Проект — «Пользователь сервисов»;

    • в блоке Сервисы — «audit.writer».

  3. Для сервисного аккаунта создайте API-ключ. В параметрах API-ключа укажите сервис «audit».

    Срок действия API-ключа ограничен. Когда он подойдет к концу, мы отправим вам уведомление. После этого необходимо обновить API-ключ.

Отправка аудит-логов через Public API

Для отправки аудит-логов через Public API необходимо отправить запрос POST.

Эндпоинт для запроса — https://audit.api.cloud.ru/events/{projectID}/send, где {projectId} — ID проекта, в который будут отправлены аудит-логи.

  1. В заголовке Authorization передайте API-ключ:

     
    Authorization: Api-Key <user-api-key>

    Где <user-api-key> — API-ключ.

  2. В теле запроса передайте:

     
    {
        "datetime": 1737715508754,
        "serviceName": "Customer",
        "serviceVersion": "v1",
        "name": "UpdateStudio",
        "sessionId": "d32cd3d2-da97-4643-8172-fb2cc89b6aea",
        "userLogin": "userlogin",
        "userName": "User Name",
        "userNode": "29.1.224.93",
        "tags": ["GT2","GT3"],
        "params": [
            {
                "name": "name0",
                "value": "val0"
            },
            {
                "name": "name1",
                "value": "val1"
            }
        ]
    }

    Где:

    • datetime — время, в которое произошло событие, указанное в Unix timestamp в миллисекундах.

    • serviceName — название сервиса-источника события. Созданные значения для сервисов-источников можно посмотреть в списке. Для проверки функциональности работы API используйте тестовое значение: "serviceName": "Customer".

    • serviceVersion — версия сервиса.

    • name — тип события. Название типа события можно посмотреть в списке. Если вы проверяете функциональность работы API и используете "serviceName": "Customer", то для поля name используйте произвольное имя типа события в формате ^[a-zA-Z]{0,55}$).

    • sessionId — ID запроса.

    • userLogin — логин пользователя.

    • userName — имя пользователя.

    • userNode — адрес субъекта события.

    • tags — опциональное поле, массив строк с набором тегов.

    • params — детали события. Сервис-источник сам определяет состав параметров внутри объекта.

Вскоре после отправки запроса в сервисе «Аудит-логирование» появится лог с переданными данными. Созданные логи можно посмотреть в таблице.
Была ли статья полезной ?
Предыдущая статья
Справочник API
Следующая статья
Решение проблем
/ DOCS
Evolution