Updated on 2025-11-28 GMT+08:00

Exporting a Job

Function

This API is used to export a job, including job definitions, job dependency scripts, and CDM job definitions.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

  • URI format

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

  • Parameter description
    Table 1 URI parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID. For details about how to obtain a project ID, see Project ID and Account ID.

    job_name

    Yes

    String

    Job name.

Request Parameters

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

workspace

No

String

Workspace ID.

  • If this parameter is not set, data in the default workspace is queried by default.
  • To query data in other workspaces, this header must be carried.
    NOTE:
    • You need to specify a workspace for multiple DataArts Studio instances.
    • This parameter is mandatory if no default workspace is available. If you do not set it, an error is reported.
Table 3 Parameter

Parameter

Mandatory

Type

Description

exportDepend

No

boolean

Whether to export the scripts and resources on which the job depends. The value can be true or false.

Default value: true

obsPath

No

String

OBS path to which the job is exported

  • If this parameter is not set, the job file stream data is exported to a local path by default.
  • If you want to export the job to OBS, specify this parameter. Example value: obs://test_bucket/job_nodes/

exportStatus

No

String

Job export status. The options are as follows:

  • DEVELOP: development state (default)
  • SUBMIT: submitted state

Response Parameters

The value of Content-Type in the response message is application/octet-stream that needs to be converted into a file. For details, see Parsing a Stream in a Response Message. Response messages are compressed as a file. The file name format is DLF_job_name.zip. The file directory is as follows:

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

Table 4 describes the file directory parameters.

Table 4 Response parameters

Parameter

Mandatory

Type

Description

job_name

Yes

String

Job name.

script_name

No

String

Name of the script that the job depends on.

resource_name

No

String

Name of the resource that the job depends on.

  • {job_name}.job

    The parameters in the file are the same as the request parameters of the API for creating a job. For details, see Creating a Job.

  • {script_name}.script

    The parameters in the file are the same as the request parameters of the API for creating a resource. For details, see Creating a Script.

Example Request

Export job myJob.
POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/myJob/export

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

Example Response

  • Success response

    HTTP status code 200

    The name of the exported file is DLF_myJob.zip. The file structure after decompression is as follows:

    jobs
    ├─myJob.job
    scripts
    ├─CS_PROCESS_TRIP.script
    ├─TRIP_RAW_STANDARD.script
  • Failure response

    HTTP status code 400

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