Help Center/ DataArts Studio/ API Reference/ DataArts Factory APIs (V1)/ Job Development APIs/ Importing a Job
Updated on 2024-11-06 GMT+08:00
View PDF
Share

Importing a Job

Function

This API is used to import one or more job files from OBS to DLF.

Before using this API, store job files in OBS buckets.

URI

  • URI format

    POST /v1/{project_id}/jobs/import

  • Parameter description
    Table 1 URI parameter

    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.

Request Parameters

Table 2 Request parameters

Parameter

Mandatory

Type

Description

path

Yes

String

If OBS is deployed, it refers to the OBS path for storing the job definition file. For the format of the job definition file, see the response message of the exported job, for example, obs://myBucket/jobs.zip.

params

No

Map<String,String>

Public job parameters

sameNamePolicy

No

String

Policy for specifying how to handle duplicate names. The options are as follows:

  • SKIP
  • OVERWRITE

Default value: SKIP

jobsParam

No

List<JobParam>

Job parameter. For details, see Table 3.

executeUser

No

String

User that executes the job

targetStatus

No

String

This parameter is required if the review function is enabled. It indicates the target status of the job. The value can be SAVED, SUBMITTED, or PRODUCTION.

  • SAVED indicates that the job is saved but cannot be scheduled or executed. It can be executed only after submitted and approved.
  • SUBMITTED indicates that the job is automatically submitted after it is saved and can be executed after it is approved.
  • PRODUCTION indicates that the job can be directly executed after it is created. Note: Only the workspace administrator can create jobs in the PRODUCTION state.

approvers

No

List<JobApprover>

Job approver. This parameter is required if the review function is enabled. For details, see Table 4.

For details about how to configure the review function, see Review Center.

resources

No

List<JobResourceInfo>

This parameter is mandatory for replacing a resource. You must set the name and type of the resource to be replaced, and the name of the resource used to replace the existing resource. For details, see Table 5.
Table 3 JobParam parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Job name

params

No

Map<String,String>

Job parameters
Table 4 Approver attributes

Parameter

Mandatory

Type

Description

approverName

Yes

String

Approver name
Table 5 Resource table parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Resource name

type

Yes

String

Resource type. The following resource types are supported:

DWS_CONNECTION, DIS_STREAM, CDM_CLUSTER, MRS_CLUSTER, MRS_HIVE_CONNECTION, MRS_SPARK_CONNECTION, GES_GRAPH, ROMA_INSTANCE, TICS_INSTANCE, and DRS_TASK

replace

No

String

Name of the resource used to replace the existing resource

Response

Table 6 Response parameter

Parameter

Mandatory

Type

Description

taskId

Yes

String

ID of the task. Used to call the API for querying system tasks to obtain the import status.

Example Request

Import jobs from OBS to DLF. If there are jobs and scripts with the same name, overwrite them. The definition file of the imported job is in the obs://aaaaa/job_batch.zip OBS path, and the job name is job_batch. 
POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/import
{
    "path": "obs://aaaaa/job_batch.zip",
    "jobsParam": [
        {
            "name": "job_batch"
        }
    ]
}
Import jobs from OBS to DLF when the review function is enabled. If there are jobs and scripts with the same name, overwrite them. 
POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/import
{
    "path": "obs://aaaaa/job_batch.zip",
    "jobsParam": [
        {
            "name": "job_batch"
        }
    ],
    "targetStatus": "SUBMITTED",
    "approvers": [
    {
      "approverName": "userName1"
    },
    {
      "approverName": "userName2"
    }
  ]
}

Example Response

  • Success response
    HTTP status code 200 
    {
    "taskId":"008aae2e675933c7016759418e870000"
}
  • Failure response

    HTTP status code 400

    {
    "error_code":"DLF.0815",
    "error_msg":"Fail to read OBS file."
}
Parent Topic: Job Development APIs