请求地址

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

请求消息

请求参数

请求参数：xmlData（必填）

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

<info>

   <dbsourse>

       <savepath>mysql145</savepath>

       <vendor>mysql</vendor>

       <user>admin</user>

       <pass>admin</pass>

       <secure>true</secure>

      <max>10</max>

     <catalog>default</catalog>

     <schema></schema>

     <note>备注</note>

    <driver>com.mysql.jdbc.Driver</driver>

    <customDriver></customDriver>

    <url>jdbc:mysql://192.168.0.1434:3306</url>

       <connProperties>  

          {"bb":"cc"}      

       </connProperties>

       <confProperties>    

           {"cc":"cc"}              

       </confProperties>

       <params>

        {"abc":"ddd"}

       </params>

   </dbsourse>

</info>

参数描述

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

•vendor（必填）：数据库的类型。参数为：oracle、db2、sqlserver、mysql、derby、informix、sybase、vertica、hive、access、analyticdb、elasticsearch、fusioninsightelk、fusioninsighthd、gaussdb100、gaussdb200、gbase、generic、greenplum、hana、hbase、hive、huaweiclouddws、impala、kingbase、kylin、maxcompute、postgresql、presto、spark、teradata、thunderengine、transwarp、oracleessbase、sapbw、ssas、mongo。

•url（选填）：url链接。

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

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

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

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

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

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

•driver（选填）：默认驱动的名称。

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

•connProperties（选填）：数据库的基本属性。

•confProperties（选填）：数据库的高级属性。

•params（选填）：数据库自定义的参数。

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

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

•fetchSize（选填）：fetchsize；默认值：100。

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

示例

function updateDbSource() {

       var xml = getXml();

       $.post("http://" + ip + ":" + port + "/" + project + "/api?action=updateDbSource&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>\\bihome\query\___CONNECTION___\.conn (系统找不到指定的文件。)</message>

   </result>

</results>

•操作失败，自定义驱动不存在

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

<results>

   <result>

       <level>6</level>

       <message>自定义驱动5未找到</message>

   </result>

</results>

结果描述

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

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

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