请求地址

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

请求消息

请求参数

请求参数：xmlData

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

<info>

<path>test/test1</path>

<type>sql</type>

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

<cron>1</cron>

<updateCol></updateCol>

<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（必填）: 输入数据集路径。

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

sql                            sql数据集

mongo                    mongo数据集

excel                        excel数据集

composite              组合数据集

custom                   定制数据集

data_flow             自服务数据集

restful                        RESTful数据集

➢注意：

如果输入的数据集已经存在抽数任务，则将会覆盖之前创建的抽数。

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

•cron（选填）：若无startTS参数则不处理此参数，若有startTS则必填，必须输入每天/每周/每月频率的cron表达式，cron表达式的形式参考创建作业-时间频率；

•updateCol（选填）：不填默认全部数据入集市，填写则需要输入数据集中存在的列名，按照所输入的列，将更新的数据追加到历史数据中，只能输入日期列或者数字列；

•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 extractDataJob() {

       var xml = getXml();

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

          {xmlData : xml},

          function(result) {        

             writeXml(result);

          });

    }

响应消息

响应结果

•创建成功。

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

<result>

         <level>1</level>

         <message>{Extraction/TEST22_20220310155536}</message>

</result>

•创建失败。

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

<result>

         <level>6</level>

         <message>请输入数据集类型</message>

</result>

结果描述

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

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

•message为接口操作结果信息