请求地址

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

请求消息

请求参数

请求参数：xmlData

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

<info>

<path>test/test1</path>

<name>test</name>

<startTS>2022-05-16 15:32:56</startTS>

<cron>1</cron>

<qryPath>test</qryPath>

<qryType>sql</qryType>

<connection>testjk</connection>

<table>testdate</table>

<combine></combine>

<params>

<param>

<name>a</name>

<type>string</type>

<multiple>false</multiple>

<value>test</value>

<failRetrySupport>true</failRetrySupport>

<failRetryInterval>4</failRetryInterval>

<failRetryTimes>5</failRetryTimes>

</param>

</params>

<user>test</user>

</info>

参数描述

•path（选填）：输入创建作业的路径，如果无此参数或为空则默认为创建在作业根目录；

•name（必填）：需要满足调度任务名称格式要求（不能有非法字符）；

•startTS（选填）：输入开始时间，不输入默认为手动运行；

•cron（选填）: 若无startTS参数则不处理此参数，若有startTS且不填或无此参数，则默认此job的时间频率为执行一次，cron表达式的形式参考创建作业-时间频率；

•qryPath（必填）: 输入导出的数据集路径；

•qryType（必填）: 输入数据集类型，目前支持输入

sql                            sql数据集

mongo                    mongo数据集

excel                        excel数据集

composite              组合数据集

cloud                       数据集市数据集

embed                    内嵌数据集

custom                   定制数据集

data_flow             自服务数据集

restful                        RESTful数据集

•connection（必填）：导出的数据源全路径，仅MySQL、SQLServer、DB2、Oracle、Derby、PostgreSQL、Gbase8a、Hive、Hana、GaussDB100、GaussDB200和DAMENG数据库支持导出；

•table（必填）：导出到数据库的表名，若表名不存在将新建表；

•combine（选填）：是否追加，不填或为空则默认为false，为true则数据集中的数据将被添加到表中而不删除表中已有的数据，如果输入不为空且不是true或者false，也当做输入为false进行处理；

•params（选填）：导出任务中设置的参数集合，不填则视为无参数；

•params-param（选填）：导出任务中需要设置的参数；

•params-param-name（在param中必填）：导出任务中需要设置的参数的名称；

•params-param-type（选填）：导出任务中需要设置的参数的类型，不填写或值为空默认为不改变当前参数的类型，如果是新增参数，则不填默认为string类型，支持填写的类型有string、boolean、float、double、int、short、long、char、byte、date、time、dateTime；

•params-param-multiple，导出任务中参数设置为单个/空或多个值，默认为false即参数为单个值或空，输入为true时参数为多个值，以英文逗号进行分隔（约定多个值情况下参数中不能有逗号），如果输入不为空且不是true或者false，也当做输入为false进行处理；

•params-param-value（选填）：导出任务中给参数的赋值，不填写则使用参数默认值，值为空视为将参数置空；

•user（选填）: 任务的授权用户，参数为空或无此参数默认以调用token用户为授权用户。

•failRetrySupport（选填）：调度任务失败重试，默认为false；当为true时开启调度任务重试功能。

•failRetryInterval（选填）：调度任务失败重启间隔；failRetrySupport为true时必填；正整数。

•failRetryTimes（选填）：调度任务失败重启时间；failRetrySupport为true时必填；正整数且最大值为5。

示例

function exportToDbJob() {

 var xml = getXml();

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

    {xmlData : xml},

    function(result) {

    writeXml(result);

 });

}

响应消息

响应结果

•操作成功

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

<result>

         <level>1</level>

         <message>保存成功</message>

</result>

•操作失败

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

<result>

         <level>6</level>

         <message>目前仅MySQL、SQLServer、DB2、Oracle、Derby、PostgreSQL、Gbase8a、Hive、Hana、GaussDB100、GaussDB200和DAMENG数据库支持导出</message>

</result>

结果描述

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

•level 返回类型，不同数值代表不同返回状态

•message为接口操作结果信息