Yandex Metrika

Настройки дашборда

Описание

Общее описание функционала

Раздел «Настройки» в дашборде позволяет просматривать и менять параметры интерфейса, транспорта и связанных возможностей, а также при необходимости экспортировать и импортировать конфигурацию в JSON. Часть действий привязана к платным возможностям тарифа: на бесплатном плане соответствующие элементы отображаются неактивными с подсказкой о смене тарифа, а сервер дополнительно проверяет права при сохранении.

Как пользователь может использовать

  • Открыть Настройки в дашборде (/dashboard/settings) после входа в аккаунт.
  • Изменить параметры интерфейса (заголовок, цвета и др.), если это разрешено тарифом и ролью.
  • Настроить параметры UDP и QUIC/DTLS, когда соответствующие возможности доступны в продукте и на тарифе.
  • Включить или отключить опции, связанные с аудитом, если функция доступна.
  • Экспортировать текущую конфигурацию в JSON для резервного копирования или переноса на другую среду.
  • Импортировать ранее сохранённый JSON через форму в разделе настроек.
  • Увидеть заблокированные разделы на бесплатном тарифе и перейти к смене плана из подсказки в интерфейсе.
  • Администратор сохраняет глобальные параметры, влияющие на отображение и поведение панели, через те же экраны и API настроек.

Как это реализовано в сервисе

Пользователь работает в дашборде: форма отправляет изменения на сервер, который проверяет сессию, роль и права по тарифу, затем применяет допустимые параметры к конфигурации интерфейса и транспорта. Экспорт отдаёт снимок текущих настроек; импорт разбирает JSON и обновляет только разрешённые поля. Изменения вступают в силу без перезапуска клиента туннеля; для части параметров может потребоваться обновление страницы или повторный вход.

Справочник API

Публичные маршруты настроек дашборда. Для изменяющих запросов требуется активная сессия; в текущей версии сохранение глобальных параметров доступно администратору.

Сохранение настроек

POST /ui/settings

  • Назначение: обновить параметры интерфейса, транспорта и связанных опций из формы дашборда.
  • Авторизация: сессия; без прав администратора — 403 Forbidden.
  • Успех: перенаправление обратно на страницу настроек.

Экспорт

GET /ui/settings/export

  • Назначение: скачать JSON с текущей конфигурацией.
  • Авторизация: сессия администратора.
  • Успех: файл ui-config.json (или аналогичное имя, заданное клиентом).

Импорт

POST /ui/settings/import

  • Назначение: загрузить JSON конфигурации (форма multipart или тело с полезной нагрузкой по контракту интерфейса).
  • Авторизация: сессия администратора.
  • Успех: перенаправление на страницу настроек с применёнными полями.

Ошибки

401 Unauthorized

Сеанс пользователя отсутствует или истёк. Войдите в дашборд заново и повторите операцию.

403 Forbidden

Текущий пользователь может просматривать настройки, но не может сохранять глобальные параметры. Для изменения обратитесь к администратору.

400 Bad Request

Форма или импортированный JSON содержит неизвестное поле, неверный формат или недопустимое значение. Исправьте данные и повторите импорт или сохранение.

413 Payload Too Large

Файл импорта превышает допустимый размер. Уменьшите файл и повторите загрузку.

Ограничения

  • Глобальные изменения настроек доступны только администратору; обычный пользователь видит только разрешённые ему параметры.
  • После импорта часть параметров может потребовать обновления страницы или повторного входа.
  • Экспорт содержит только поддерживаемые интерфейсом настройки и не является полной копией конфигурации сервиса.
  • Возможности, зависящие от тарифа, могут отображаться заблокированными до смены плана.