更新时间:2024-08-27 GMT+08:00
分享

批量导出作业

功能介绍

此接口可以批量导出DLF作业定义,包括作业依赖的脚本和CDM作业定义。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。

URI

  • URI格式

    POST /v1/{project_id}/jobs/batch-export

  • 参数说明
    表1 URI参数说明

    参数名

    是否必选

    参数类型

    说明

    project_id

    String

    项目编号,获取方法请参见项目ID和账号ID

请求参数

表2 请求Header参数

参数名

是否必选

参数类型

说明

workspace

String

工作空间id。

  • 如果不设置该参数,默认查询default工作空间下的数据。
  • 如果需要查询其他工作空间的数据,需要带上该消息头。
表3 参数说明

参数名

是否必选

参数类型

说明

jobList

列表数据结构

要导出的作业名称列表,一次最多支持导出100个作业。

exportDepend

boolean

是否导出作业依赖的脚本和资源。

默认值:true

响应参数

批量导出作业响应消息和导出作业响应消息一致,请参考 响应参数

请求示例

导出两个作业,作业名称分别为job_batch和job_stream。是否导出作业依赖的脚本和资源默认为true。
POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/batch-export
{
   "jobList":["job_batch","job_stream"],
   "exportDepend":true
}

响应示例

  • 成功响应

    响应消息的Content-Type是application/octet-stream,需要解析转化为一个文件,可以参考解析响应消息体中的流样例代码。响应是一个压缩文件,文件名为jobs.zip,解压后文件结构如下:

    jobs
    +---job_batch
    |       dws_sql.script
    |       job_batch.job
    \---job_stream
    job_stream.job

    job_batch.job和job_stream.job是作业定义文件

    dws_sql.script是job_batch.job所使用的DWS SQL脚本文件。

  • 失败响应

    HTTP状态码 400

    {
        "error_code":"DLF.3051",
        "error_msg":"The request parameter is invalid."
    }

相关文档