Метод POST /v1/db-connections/check-connection

Краткое описание

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

  • Возвращает статус подключения и возможные ошибки.

Тело запроса

  • JSON объект с параметрами подключения, соответствующий схеме DBConnectionCreateSchema.

  • Обязательные поля:

    • host (string) — адрес сервера базы данных.

    • port (int) — порт для подключения.

    • username (string) — имя пользователя для подключения.

    • password (string) — пароль для подключения.

    • database (string) — имя базы данных.

Пример тела запроса:

{
  "host": "localhost",
  "port": 5432,
  "username": "user",
  "password": "password",
  "database": "mydatabase"
}

Алгоритм работы метода

  • Принимает параметры подключения из тела запроса.

  • Устанавливает соединение с базой данных с использованием предоставленных параметров.

  • Если соединение успешно:

  • Возвращает статус 200 OK с сообщением о успешном подключении.

  • Если соединение не удалось:

  • Возвращает статус 400 Bad Request с описанием ошибки подключения.

Успешный ответ (200)

  • Content-Type: application/json

  • Тело: объект с сообщением о статусе подключения.

Примечания

  • Убедитесь, что параметры подключения корректны и сервер базы данных доступен.

  • Для повышения безопасности рекомендуется использовать безопасные методы хранения паролей.