查询表下所有导出任务列表

接口地址：/api/v1/tableExportTask/list?dataset_guid

请求方式: GET

请求参数：

参数名称	参数说明	请求类型	是否必须	数据类型
dataset_guid	dataset_guid="catalog"."schema"."table" （表的唯一表示，注意带引号）	query	true	string

响应信息：

{
  "data":[{
    "id":"xx", // 导出任务唯一id
    "name":"xxx", // 导出任务名称
    "description":"xxxx", // 导出任务描述信息
    "datasetGuid":"\"catalog\".\"schema\".\"table\"", // 表唯一id
    "sourceTablePathList":['catalog','schema','table'], // 表路径数
    "sourceCatalogName":"catalogName", 
    "sourceSchemas":["schemaName01","schema02"],
    "sourceTableName":"tableName",
    "state":"ENABLE/DISABLE", // 导出任务状态
    "target":{ // 目标源信息
      "datasourceGuid":"\"catalogName\"",
      "schemaGuid":"\"catalogName\".\"schemaName01\"",
      "tableGuid":"",
      "catalogName":"catalogName",
      "schemas":["schemaName1","schemaName02"],
      "table":"表名称(目标是文件源table和fileName一样)",
      "fileName":"文件名称", // 文件名称
      "needCreateTable": true / false, // 是否新建表
      "writeMode":"APPEND/OVERWRITE", // 同名文件处理方式
      "isPartition": true / false,
      "fileFormat":"json/csv/orc/parquet", // 文件格式
      "fileSeparator":"",
      "duplicatedFileHandleMethod":"IGNORE/OVERWRITE",
      "options":{}, // 高级配置参数 map key-value格式
      "partitionConfig":{ // 分区信息
        "partitionField":"", // 分区字段
        "partitionValue":"", // 分区值
        "valueType":"CONSTANT/VARIABLE/MAPPING"
      },
      "columnMappings":[{ // 字段映射
        "sourceColumnName":"",
        "targetColumnName":""
      }],
      "scheduleConfig":{
        "type":"MANUAL/AUTO/SCHEDULE",
        "cronTab":"cron表达式"
      },
      "owner":{
        "userId":"xx",
        "username":"xxxx"
      },
      "createTime":1756207752111,
      "updateTime":1756280458537,
      "latestExecuteTime":1760354441190,
    }
  }],
  "errorCode":"",
  "errorMsg":"",
  "success": true / false
}

根据任务Id查询单个导出任务详情

接口地址：/api/v1/tableExportTask/detail?dataset_guid=&task_id=

请求方式: GET

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
dataset_guid	dataset_guid="catalog"."schema"."table" （表的唯一表示，注意带引号）	query	true	string
task_id	导出任务唯一id	query	true	string

响应信息：

{
  "data":{
    "id":"xx", // 导出任务唯一id
    "name":"xxx", // 导出任务名称
    "description":"xxxx", // 导出任务描述信息
    "datasetGuid":"\"catalog\".\"schema\".\"table\"", // 表唯一id
    "sourceTablePathList":['catalog','schema','table'], // 表路径数
    "sourceCatalogName":"catalogName", 
    "sourceSchemas":["schemaName01","schema02"],
    "sourceTableName":"tableName",
    "state":"ENABLE/DISABLE", // 导出任务状态
    "target":{ // 目标源信息
      "datasourceGuid":"\"catalogName\"",
      "schemaGuid":"\"catalogName\".\"schemaName01\"",
      "tableGuid":"",
      "catalogName":"catalogName",
      "schemas":["schemaName1","schemaName02"],
      "table":"表名称(目标是文件源table和fileName一样)",
      "fileName":"文件名称", // 文件名称
      "needCreateTable": true / false, // 是否新建表
      "writeMode":"APPEND/OVERWRITE", // 同名文件处理方式
      "isPartition": true / false,
      "fileFormat":"json/csv/orc/parquet", // 文件格式
      "fileSeparator":"",
      "duplicatedFileHandleMethod":"IGNORE/OVERWRITE",
      "options":{}, // 高级配置参数 map key-value格式
      "partitionConfig":{ // 分区信息
        "partitionField":"", // 分区字段
        "partitionValue":"", // 分区值
        "valueType":"CONSTANT/VARIABLE/MAPPING"
      },
      "columnMappings":[{ // 字段映射
        "sourceColumnName":"",
        "targetColumnName":""
      }],
      "scheduleConfig":{
        "type":"MANUAL/AUTO/SCHEDULE",
        "cronTab":"cron表达式"
      },
      "owner":{
        "userId":"xx",
        "username":"xxxx"
      },
      "createTime":1756207752111,
      "updateTime":1756280458537,
      "latestExecuteTime":1760354441190,
    }
  },
  "errorCode":"",
  "errorMsg":"",
  "success": true / false
}

查询所有导出任务列表接口

接口地址：/api/v1/tableExportTask/query

请求方式: GET

请求参数：

参数名称	参数说明	请求类型	是否必须	数据类型
search_value	导出任务名称、视图名称，模糊搜索	query	否	String
states	导出任务状态： 1. ENABLE(启用) 2. DISABLE(停用)	query	否	List
owners	负责人userId列表	query	否	List
gteCreateTime	查询>=创建时间的	query	否	long
orderType	排序顺序： 1. ASC(升序) 2. DESC(降序)	query	否	String
orderField	排序字段： 1. lastExecutionTime(最近运行时间) 2. updateTime(最近编辑时间)	query	否	String
page_number	当前第几页，默认是1	query	否	int
page_size	每页展示条数，默认是20	query	否	int

响应信息：

{
  "data":{
    "hasNextPage": true / false,
    "list":[{
      "id":"xx", // 导出任务唯一id
      "name":"xxx", // 导出任务名称
      "description":"xxxx", // 导出任务描述信息
      "datasetGuid":"\"catalog\".\"schema\".\"table\"", // 表唯一id
      "sourceTablePathList":['catalog','schema','table'], // 表路径数
      "sourceCatalogName":"catalogName", 
      "sourceSchemas":["schemaName01","schema02"],
      "sourceTableName":"tableName",
      "state":"ENABLE/DISABLE", // 导出任务状态
      "target":{ // 目标源信息
        "datasourceGuid":"\"catalogName\"",
        "schemaGuid":"\"catalogName\".\"schemaName01\"",
        "tableGuid":"",
        "catalogName":"catalogName",
        "schemas":["schemaName1","schemaName02"],
        "table":"表名称(目标是文件源table和fileName一样)",
        "fileName":"文件名称", // 文件名称
        "needCreateTable": true / false, // 是否新建表
        "writeMode":"APPEND/OVERWRITE", // 同名文件处理方式
        "isPartition": true / false,
        "fileFormat":"json/csv/orc/parquet", // 文件格式
        "fileSeparator":"",
        "duplicatedFileHandleMethod":"IGNORE/OVERWRITE",
        "options":{}, // 高级配置参数 map key-value格式
        "partitionConfig":{ // 分区信息
          "partitionField":"", // 分区字段
          "partitionValue":"", // 分区值
          "valueType":"CONSTANT/VARIABLE/MAPPING"
        },
        "columnMappings":[{ // 字段映射
          "sourceColumnName":"",
          "targetColumnName":""
        }],
        "scheduleConfig":{
          "type":"MANUAL/AUTO/SCHEDULE",
          "cronTab":"cron表达式"
        },
        "owner":{
          "userId":"xx",
          "username":"xxxx"
        },
        "createTime":1756207752111,
        "updateTime":1756280458537,
        "latestExecuteTime":1760354441190,
      }
    }],
    "pageNumber":1,
    "pageSize":20,
    "total":36
  },
  "errorCode":"",
  "errorMsg":"",
  "success": true / false
}

查询最近任务运行状态

接口地址: /api/v1/tableExportTask/taskRecords/queryByGuid

请求方式: GET

接口描述: 根据表的guid查询当前表下所有导出任务最近运行状态，必须携带dataset_guid, names可以不携带，如果不携带，查询表下的所有导出任务最近运行状态。

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
dataset_guid	表guid	query	是	String
names	导出任务名称列表	query	否	String列表

响应信息:

{
  "data":[{
    "id":"", //最近运行状态这条记录的唯一id
    "taskId":"", // 导出任务唯一id
    "state":"RUNNING/SUCCESS/FAILED/CANCELED", //最近运行状态
  }],
  "errorCode":"",
  "errorMsg":"",
  "success": true / false
}

执行导出任务

接口地址: /api/v1/tableExportTask/{taskId}/run

请求方式: POST

接口描述: 根据任务id执行导出任务

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
partitionValue	分区值用逗号隔开	BODY	否	String

请求体示例:

{
  "partitionValue":"value1,value2"
}

响应信息:

{
  "data":null, // 无返回值
  "errorCode":"",
  "errorMsg":"", // 执行失败后的具体报错信息
  "success": true / false // true表示执行导出任务成功，false失败，
}

重跑导出任务

接口地址: /api/v1/tableExportTask/{taskId}/record/{recordId}/rerun

请求方式: POST

接口描述: 根据任务id + 任务记录id重跑导出任务。即查询出执行导出任务那条记录，然后再重跑一次。

请求参数: 无

响应信息:

{
  "data":null, // 无返回值
  "errorCode":"",
  "errorMsg":"", 
  "success": true / false // true表示重跑导出任务成功，false表示失败
}

取消导出任务

接口地址: /api/v1/tableExportTask/{taskId}/record/{recordId}/cancel

请求方式: POST

接口描述: 根据任务id + 任务记录id取消执行，如果前面你调用了重跑导出任务，但是想取消掉，可以调用这个接口

请求参数: 无

响应信息:

{
  "data":null, // 无返回值
  "errorCode":"",
  "errorMsg":"",  // 具体报错信息
  "success": true / false // true表示取消任务成功，false表示取消失败
}