更新时间:2025-08-25 GMT+08:00
分享

导出作业

功能介绍

导出zip压缩包格式的作业文件,包括作业定义、作业依赖的脚本、CDM作业定义。

调试

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

URI

  • URI格式

    POST /v1/{project_id}/jobs/{job_name}/export

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

    参数名

    是否必选

    参数类型

    说明

    project_id

    String

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

    job_name

    String

    作业名称。

请求参数

表2 请求Header参数

参数名

是否必选

参数类型

说明

workspace

String

工作空间id。

  • 如果不设置该参数,默认查询default工作空间下的数据。
  • 如果需要查询其他工作空间的数据,需要带上该消息头。
    说明:
    • 多个DataArts Studio实例需要指定工作空间。
    • 当工作空间里面没有default工作空间时,工作空间为必填参数,否则会报错。
表3 请求参数说明

参数名

是否必选

参数类型

说明

exportDepend

boolean

是否导出作业依赖的脚本和资源,取值为true或者false。

默认值:true

obsPath

String

导出作业的OBS目标地址

  • 如果不设置该参数,默认导出作业文件流数据到本地。
  • 如果需要将作业导出到OBS,需要带上该参数,样例:obs://test_bucket/job_nodes/

exportStatus

String

导出作业的状态,取值如下:

  • DEVELOP:开发态,默认是开发态
  • SUBMIT:提交态

响应参数

响应消息的Content-Type是application/octet-stream,需要解析转化为一个文件,可以参考解析响应消息体中的流样例代码。响应是一个压缩文件,文件名称格式DLF_{job_name}.zip,压缩文件里面的文件目录如下:

jobs
├─{job_name}.job
scripts
├─{script_name}.script
resources
├─{resource_name}.resource

上述文件名中的参数说明如表4所示。

表4 参数说明

参数名

是否必选

参数类型

说明

job_name

String

作业名称

script_name

String

作业所依赖的脚本名称。

resource_name

String

作业所依赖的资源名称。

  • {job_name}.job文件内容

    文件中的参数与创建作业接口的请求参数一样,请参考创建作业

  • {script_name}.script文件内容

    文件中的参数与创建资源接口的请求参数一样,请参考创建脚本

请求示例

导出作业myJob。
POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/myJob/export

{
    "obsPath": "obs://000dpstestdata/job_nodes/",
    "exportDepend": true,
    "exportStatus": "SUBMIT"
}

响应示例

  • 成功响应

    HTTP状态码 200

    导出文件名为DLF_myJob.zip,解压后文件结构如下:

    jobs
    ├─myJob.job
    scripts
    ├─CS_PROCESS_TRIP.script
    ├─TRIP_RAW_STANDARD.script
  • 失败响应

    HTTP状态码 400

    {
        "error_code":"DLF.0100",
        "error_msg":"The job does not exists."
    }

相关文档