请求地址

http://ip:port/bi/api?action=saveDbSource&token=xxxx

请求消息

请求参数

请求参数：xmlData（必填）

<?xml version="1.0" encoding="utf-8"?>

<info>

<dbsourse>

  <savepath>测试数据源</savepath>

  <vendor>oracle</vendor>

   <driver>oracle.jdbc.driver.OracleDriver</driver>

  <customDriver></customDriver>

  <url>jdbc:oracle:thin:@192.168.1.90:1521:orcl</url>

  <user>admin</user>

  <pass>admin</pass>

  <secure>true</secure>

  <max>10</max>

  <catalog>default</catalog>

  <schema></schema>

 <note>备注</note>

</dbsourse>

</info>

参数描述

•savepath（必填）：要保存的数据源的名字（在文件夹下，是一个路径，如test/测试数据源）

•vendor（选填）：数据库的类型。参数为：access、analyticdb、clickhouse、ctsdb、dameng、db2、derby、doris、elasticsearch、fusioninsightelk、fusioninsighthd、gaussdb100、gaussdb200、gbase、generic、greenplum、hana、hbase、hive、huaweiclouddws、impala、informix、kingbase、kyligenceenterprise、kylin、kyligencemdx、maxcompute、mongo、mysql、neo4j、oracle、oracleessbase、postgresql、presto、sapbw、spark、sqlserver、starrocks、ssas、sybase、tbds、tbdsolap、teradata、tidb、transwarp、vertica。

•driver（选填）：默认驱动的名称，如果不填或为空则默认使用界面上默认驱动列表的第一个驱动。

•customDriver（选填）：自定义驱动名称，如果不填或为空则使用默认驱动，如果填写了则忽略默认驱动的内容，使用所填写的自定义驱动。

•url（必填）：url链接

•user（选填）：连接数据库的用户名

•pass（选填）：连接数据库的密码

•secure（选填）：true，表示需要身份认证；false，表示无身份认证。

•max（选填）：数据源的最大连接数。

•catalog（选填）：表示默认数据库。

•schema（选填）：表示表结构模式。

•note（选填）：数据源的备注。

•hiddenconn(选填)：仅对有写权限的用户可见，可填值true/false，默认：false。

•useConnPool(选填)：是否使用连接池：true，使用；false，不使用；默认值false。

•connTimeOut(选填)：有效连接时间 1~1073741823，默认值：7200000。

•fetchsize(选填)：fetchsize，默认值：100

•sqlViewType(选填)：获取列注释为；1不获取，2为备注，3为别名；默认值：2。

•如果两次添加的savepath一致，此方法会覆盖掉之前所添加的数据源。

示例

function addDbSource() {

       var xml = getXml();

       $.post("http://" + ip + ":" + port + "/" + project + "/api?action=saveDbSource&token=xxxx",

          {xmlData : xml},

          function(result) {        

             writeXml(result);

          });

    }

响应消息

响应结果

•操作成功

<?xml version="1.0" encoding="utf-8"?>

<results>

<result>

  <level>1</level>

  <message>添加成功。</message>

</result>

</results>

•操作失败

<?xml version="1.0" encoding="UTF-8"?>

<results>

 <result>

    <level>6</level>

    <message>配置失败，自定义驱动{0}不存在</message>

 </result>

</results>

结果描述

响应结果信息为xml，直接parse即可。

•level 返回类型，不同数值代表不同返回状态，见附录。

•message为接口操作结果信息，当level为1的时候，表示保存成功，message信息为保存的数据源的信息。