5.Управление подключениями к данным

GET Получение списка подключений к данным#

Основная информация#

Статус интерфейса: Опубликован

URL интерфейса: GET {{API_PATH_V3}}/connection

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

Параметры запроса: Пока нет примеров данных для ответа

Возвращаемые параметры (json + таблица)#

Success (200)#

json

{
    "status": 200,
    "data": [
        {
            "connectionType": "jdbc",
            "connectionName": "Name",
            "connectionData": "{\"connectionId\":null,\"database\":\"mysql\",\"connectionName\":null,\"driver\":\"com.mysql.jdbc.Driver\",\"url\":\"jdbc:mysql://hostname:port/database\",\"user\":\"\",\"password\":\"********\",\"newCharsetName\":null,\"originalCharsetName\":null,\"schema\":\"\",\"options\":null,\"port\":0,\"authType\":\"\",\"creator\":\"root\",\"principal\":\"\",\"keyPath\":\"\",\"krb5Path\":\"\",\"connectionPoolAttr\":{\"initialSize\":0,\"maxActive\":50,\"maxIdle\":0,\"minIdle\":0,\"maxWait\":10000,\"validationQuery\":\"\",\"testOnBorrow\":true,\"testOnReturn\":false,\"testWhileIdle\":false,\"timeBetweenEvictionRunsMillis\":60000,\"numTestsPerEvictionRun\":3,\"minEvictableIdleTimeMillis\":1800},\"useJaas\":false,\"fetchSize\":-1,\"driverSource\":\"\",\"usingSsh\":false,\"sshType\":\"NORMAL\",\"sshUser\":\"\",\"sshIp\":\"hostname\",\"sshPort\":22,\"redirectPort\":0,\"redirectIp\":\"\",\"sshTimeOut\":10000,\"sshKeepAlive\":10000,\"sshSecret\":\"********\",\"sshPrivateKeyPath\":\"\",\"usingSsl\":false,\"sslType\":\"NORMAL\",\"sslClientPrivateKey\":\"\",\"sslClientCertificate\":\"\",\"caCertificate\":\"\",\"verifyCa\":false,\"sslCipher\":\"\",\"identity\":\"0a1a99569c2ff08a\",\"properties\":{},\"privilegeDetailBeanList\":null}",
            "connectionId": null,
            "creator": "root",
            "privilegeDetailBeanList": null,
            "urls": [
                "jdbc:mysql://hostname:port/database"
            ]
        },
        {
            "connectionType": "jdbc",
            "connectionName": "Name",
            "connectionData": "{\"connectionId\":null,\"database\":\"mysql\",\"connectionName\":null,\"driver\":\"com.mysql.jdbc.Driver\",\"url\":\"jdbc:mysql://hostname:port/database\",\"user\":\"\",\"password\":\"********\",\"newCharsetName\":null,\"originalCharsetName\":null,\"schema\":\"\",\"options\":null,\"port\":0,\"authType\":\"\",\"creator\":\"root\",\"principal\":\"\",\"keyPath\":\"\",\"krb5Path\":\"\",\"connectionPoolAttr\":{\"initialSize\":0,\"maxActive\":50,\"maxIdle\":0,\"minIdle\":0,\"maxWait\":10000,\"validationQuery\":\"\",\"testOnBorrow\":true,\"testOnReturn\":false,\"testWhileIdle\":false,\"timeBetweenEvictionRunsMillis\":60000,\"numTestsPerEvictionRun\":3,\"minEvictableIdleTimeMillis\":1800},\"useJaas\":false,\"fetchSize\":-1,\"driverSource\":\"\",\"usingSsh\":false,\"sshType\":\"NORMAL\",\"sshUser\":\"\",\"sshIp\":\"hostname\",\"sshPort\":22,\"redirectPort\":0,\"redirectIp\":\"\",\"sshTimeOut\":10000,\"sshKeepAlive\":10000,\"sshSecret\":\"********\",\"sshPrivateKeyPath\":\"\",\"usingSsl\":false,\"sslType\":\"NORMAL\",\"sslClientPrivateKey\":\"\",\"sslClientCertificate\":\"\",\"caCertificate\":\"\",\"verifyCa\":false,\"sslCipher\":\"\",\"identity\":\"968aefa0a90e2f0a\",\"properties\":{},\"privilegeDetailBeanList\":null}",
            "connectionId": null,
            "creator": "root",
            "privilegeDetailBeanList": null,
            "urls": [
                "jdbc:mysql://hostname:port/database"
            ]
        },
        {
            "connectionType": "jdbc",
            "connectionName": "Name",
            "connectionData": "{\"connectionId\":null,\"database\":\"\",\"connectionName\":null,\"driver\":\"sun.jdbc.odbc.JdbcOdbcDriver\",\"url\":\"\",\"user\":\"\",\"password\":\"********\",\"newCharsetName\":null,\"originalCharsetName\":null,\"schema\":\"\",\"options\":null,\"port\":0,\"authType\":\"\",\"creator\":\"designer\",\"principal\":\"\",\"keyPath\":\"\",\"krb5Path\":\"\",\"connectionPoolAttr\":{\"initialSize\":0,\"maxActive\":50,\"maxIdle\":10,\"minIdle\":0,\"maxWait\":10000,\"validationQuery\":\"\",\"testOnBorrow\":true,\"testOnReturn\":false,\"testWhileIdle\":false,\"timeBetweenEvictionRunsMillis\":60000,\"numTestsPerEvictionRun\":3,\"minEvictableIdleTimeMillis\":1800},\"useJaas\":false,\"fetchSize\":-1,\"driverSource\":\"\",\"usingSsh\":false,\"sshType\":\"NORMAL\",\"sshUser\":\"\",\"sshIp\":\"\",\"sshPort\":22,\"redirectPort\":0,\"redirectIp\":\"\",\"sshTimeOut\":10000,\"sshKeepAlive\":10000,\"sshSecret\":\"********\",\"sshPrivateKeyPath\":\"\",\"usingSsl\":false,\"sslType\":\"NORMAL\",\"sslClientPrivateKey\":\"\",\"sslClientCertificate\":\"\",\"caCertificate\":\"\",\"verifyCa\":false,\"sslCipher\":\"\",\"identity\":\"c5df1021-6f69-1ef6-cd0f-259b1e1c2e7a\",\"properties\":{},\"privilegeDetailBeanList\":null}",
            "connectionId": null,
            "creator": "designer",
            "privilegeDetailBeanList": null,
            "urls": []
        },
        {
            "connectionType": "jdbc",
            "connectionName": "Name",
            "connectionData": "{\"connectionId\":null,\"database\":\"\",\"connectionName\":null,\"driver\":\"com.mysql.jdbc.Driver\",\"url\":\"jdbc:mysql://localhost:55001/db_test\",\"user\":\"root\",\"password\":\"********\",\"newCharsetName\":null,\"originalCharsetName\":null,\"schema\":\"\",\"options\":null,\"port\":0,\"authType\":\"\",\"creator\":\"designer\",\"principal\":\"\",\"keyPath\":\"\",\"krb5Path\":\"\",\"connectionPoolAttr\":{\"initialSize\":0,\"maxActive\":50,\"maxIdle\":10,\"minIdle\":0,\"maxWait\":10000,\"validationQuery\":\"\",\"testOnBorrow\":true,\"testOnReturn\":false,\"testWhileIdle\":false,\"timeBetweenEvictionRunsMillis\":60000,\"numTestsPerEvictionRun\":3,\"minEvictableIdleTimeMillis\":1800},\"useJaas\":false,\"fetchSize\":-1,\"driverSource\":\"\",\"usingSsh\":false,\"sshType\":\"NORMAL\",\"sshUser\":\"\",\"sshIp\":\"\",\"sshPort\":22,\"redirectPort\":0,\"redirectIp\":\"\",\"sshTimeOut\":10000,\"sshKeepAlive\":10000,\"sshSecret\":\"********\",\"sshPrivateKeyPath\":\"\",\"usingSsl\":false,\"sslType\":\"NORMAL\",\"sslClientPrivateKey\":\"\",\"sslClientCertificate\":\"\",\"caCertificate\":\"\",\"verifyCa\":false,\"sslCipher\":\"\",\"identity\":\"52250c47-912c-0d4d-700f-0fda445b4d8a\",\"properties\":{},\"privilegeDetailBeanList\":null}",
            "connectionId": null,
            "creator": "designer",
            "privilegeDetailBeanList": null,
            "urls": [
                "jdbc:mysql://localhost:55001/db_test"
            ]
        }
    ]
}

Название параметра	Значение параметра	Обязательное поле?	Тип параметра	Описание
status	200	да	Integer	Статус
data		да	Array	Возвращаемые данные
data.connectionType	jdbc	да	String	Тип подключения к данным
data.connectionName	Data Connection 2	да	String	Название подключения к данным

Название параметра	Значение параметра	Обязательное поле?	Тип параметра	Описание
data.connectionData	См. поле `connectionData` в примере JSON выше	да	String	Подробная конфигурация подключения к данным (структура различается для разных типов подключений)

Название параметра	Значение параметра	Обязательное поле?	Тип параметра	Описание
data.connectionId	null	да	Null	ID подключения (зарезервированное поле, по умолчанию пустое)
data.creator	root	да	String	Создатель
data.privilegeDetailBeanList	null	да	Null	Список разрешений (зарезервированное поле, по умолчанию пустое)
data.urls	jdbc:mysql://hostname:port/database	да	Array	URL-адрес подключения к данным (различается для разных подключений)

Failed (404)#

DEL Удаление подключения к данным#

Основная информация#

Статус интерфейса: Опубликован URL интерфейса: DEL {{API_PATH_V3}}/connection?connections=["Data connection 1"] Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

Параметры запроса

Название параметра	Значение параметра	Обязательное поле?	Тип параметра	Описание
connections	["Data connection 1"]	да	String	Наименования подключений к данным, которые требуется удалить

Параметры body запроса

Пока нет примеров данных для ответа

Возвращаемые параметры (json + таблица)#

Success (200)#

Название параметра	Значение параметра	Обязательное поле?	Тип параметра	Описание
status	200	да	Integer	Статус
data		да	Array
data.status	true	да	Boolean	Статус

Failed (404)#

JDBC подключения#

POST Добавление JDBC подключения#

Основная информация#

Статус интерфейса: Опубликован URL интерфейса: POST {{API_PATH_V3}}/connection Content-Type: application/json Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

Параметры body запроса

Название параметра	Значение параметра	Обязательное поле?	Тип параметра	Описание
connectionName	conn	да	String	Название подключения к данным
driver	org.sqlite.JDBC	да	String	Драйвер подключения к данным
driverSource	Sqlite	нет	String	Пользовательское название драйвера. Необязательно, по умолчанию используется стандартный драйвер
url	jdbc:mysql://host:port/db_test	да	String	URL JDBC-подключения
database	db_test	нет	String	Название базы данных
schema		нет	String	Схема
user	root	да	String	Имя пользователя
password	password	да	String	Пароль в открытом виде
connectionPoolAttr		нет	Object	Атрибуты пула подключений
connectionPoolAttr.initialSize	0	нет	String	Начальное количество подключений
connectionPoolAttr.maxActive	50	нет	String	Максимальное количество активных подключений
connectionPoolAttr.maxIdle	10	нет	String	Максимальное количество простаивающих подключений
connectionPoolAttr.minIdle	0	нет	String	Минимальное количество простаивающих подключений
connectionPoolAttr.maxWait	10000	нет	String	Максимальное время ожидания
connectionPoolAttr.validationQuery	select 1	нет	String	SQL-запрос для проверки
connectionPoolAttr.testOnBorrow	true	нет	String	Проверка перед получением подключения
connectionPoolAttr.testOnReturn	false	нет	String	Включение проверки при возврате в пул
connectionPoolAttr.testWhileIdle	false	нет	String	Включение проверки простаивающих подключений
connectionPoolAttr.timeBetweenEvictionRunsMillis	-1	нет	String	Время простоя перед очисткой подключений
connectionPoolAttr.numTestsPerEvictionRun	3	нет	String	Количество проверок при очистке подключений
connectionPoolAttr.minEvictableIdleTimeMillis	1800	нет	String	Минимальное время простоя перед удалением
charsetName		нет	String	Кодировка
authType		нет	String	Тип аутентификации
principal		нет	String	Клиентский principal
keyPath		нет	String	Путь к ключу keytab

Возвращаемые параметры (json + таблица)#

Success (200)#

Название параметра	Значение параметра	Обязательное поле?	Тип параметра	Описание
status	200	да	Integer	Статус
data		да	Array
data.status	success	да	String	Статус

Failed (404)#

PUT Обновление JDBC подключения#

Основная информация#

Статус интерфейса: Опубликован URL интерфейса: PUT {{API_PATH_V3}}/connection Content-Type: application/json Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

Параметры body запроса

Название параметра	Значение параметра	Обязательное поле?	Тип параметра	Описание
connectionId	conn	да	String	Параметр connectionName, передаваемый при создании подключения к данным
connectionName	new conn	нет	String	Используется для переименования подключения к данным
driver	org.sqlite.JDBC	нет	String	Драйвер
url	jdbc:mysql://host:port/db_test	нет	String	URL подключения к данным
database	mysql	нет	String
user	root	нет	String	Имя пользователя
password	password	нет	String	Пароль
connectionPoolAttr		нет	Object
connectionPoolAttr.minEvictableIdleTimeMillis	1802	нет	String

Возвращаемые параметры (json + таблица)#

Success (200)#

Название параметра	Значение параметра	Обязательное поле?	Тип параметра	Описание
status	200	да	Integer	Статус
data		да	Array
data.status	success	да	String	Статус

Failed (404)#

POST Тестирование JDBC подключения#

Основная информация#

Статус интерфейса: Опубликован URL интерфейса: POST {{API_PATH_V3}}/connection/test Content-Type: application/json Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

Параметры body запроса

Название параметра	Значение параметра	Обязательное поле?	Тип параметра	Описание
driver	org.postgresql.Driver	да	String	Драйвер
url	jdbc:postgresql://host:port/test_db	да	String	URL подключения к базе данных
database	test_db	да	String	Имя базы данных
schema		нет	String	Схема
user	user_db	да	String	Имя пользователя
password	pass!	да	String	Пароль
authType		нет	String	Способ аутентификации (используется для некоторых типов подключений, например, Kerberos)
principal		нет	String	Используется для аутентификации Kerberos
keyPath		нет	String	Используется для аутентификации Kerberos

Возвращаемые параметры (json + таблица)#

Success (200)#

Название параметра	Значение параметра	Обязательное поле?	Тип параметра	Описание
data		да	Array
status	success	да	String	Статус