Instant API: режим работы без сохранения данных

В версии 6.0.1 мы добавили новый режим работы API – Instant. В этом режиме мы не сохраняем никакие данные, все, что вы отправляете и получаете, существует только в рамках вашего запроса и ответа на него. Таким образом вы экономите место в хранилище и, что может быть особенно важно в рамках соблюдения требований законодательства, не передаете и не храните чувствительные данные.

Чтобы включить режим Instant API, при подготовке файла конфигурации (config.py) для API установите параметру OZ_APP_COMPONENTS значение stateless. Чтобы никакие данные запроса и ответа не сохранялись, отправьте следующий запрос: POST /api/instant/folders/ . Авторизация настраивается на вашей стороне.

Обратите внимание: поскольку Instant API не хранит данные, работа в таком режиме с черным списком (O2N) не предусмотрена.

При использовании Instant API с Web SDK при конфигурации адаптера установите параметру architecture значение lite. Версия Web SDK должна быть не ниже 1.7.14.

Минимальные системные требования

При указанных ниже характеристиках система может выполнять до трех анализов одновременно. Производительность в таком случае составит до 58 анализов в минуту.

• CPU: 16 ядер, 32 потока, базовая частота – 2.3 GHz, максимальная частота в турборежиме для одного ядра – 4 GHz.

• RAM: 32 GB, DDR 5, Dual Channel.

Параметры конфигурации

Перед запуском подготовьте файл конфигурации со следующими параметрами.

Обязательные параметры

Без этих параметров Instant API не запустится.

# список компонентов Oz API. Для Instant API укажите stateless
# для компонента авторизации добавьте auth
OZ_APP_COMPONENTS=stateless
# поддержка локального хранилища
OZ_LOCAL_STORAGE_SUPPORT_ENABLE=false
# адрес сервиса tfss
OZ_SERVICE_TFSS_HOST=http://xxx.xxx.xxx.xxx:xxxx
# разрешенные хосты
APP_ALLOWED_HOSTS=example-host1.com,example-host2.com
# секретный ключ
OZ_API_SECRET_KEY=long_secret_key

Установка

Docker

CONTAINER_NAME=<container name> \
DEPLOY_INSTANT_PORT_EXT=<external port> \
INSTANT_IMAGE=<provided image name> \
ADDITIONAL_PARAMS="-e LICENSE_KEY=<your license key>" \

docker run -d --name $CONTAINER_NAME
      $ADDITIONAL_PARAMS
      -p ${DEPLOY_INSTANT_PORT_EXT}:8080
      $INSTANT_IMAGE

Docker Compose

services:
  oz-api-instant:
    image: <provided image>
    container_name: oz-api-instant
    environment:
        - LICENSE_KEY=<your license key>
        # - TF_ENABLE_ONEDNN_OPTS=1 # In some cases, especially for AMD CPUs, set to 0
        # - API_LISTEN_PORT=8080
        # - LOG_LEVEL=info # ['critical', 'error', 'warning', 'info', 'debug', 'trace']
    restart: always
    ports:
      - 8080:8080

Методы Instant API

Список методов доступен по ссылке. Также вы можете скачать коллекцию для Postman:

10KB

OZ-Forensic Instant 6.0.0.postman_collection.json