Viewing a Job File

Function

This API is used to check whether there are jobs and scripts in the job file to be imported from OBS to DLF.

URI

URI format
POST /v1/{project_id}/jobs/check-file

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

**Table 2** Request parameters
Parameter	Mandatory	Type	Description
path	No	String	If OBS is deployed, the job definition file is stored on OBS, for example, obs://myBucket/jobs.zip.

Response

**Table 3** Response parameters
Parameter	Mandatory	Type	Description
jobs	No	List<Job>	Job information. For details, see Table 4.
scripts	No	List<Script>	Script information. For details, see Table 5.

**Table 4** job data structure description
Parameter	Mandatory	Type	Description
params	No	Map<String,String>	Job parameter.
name	Yes	String	Job name.
path	Yes	String	Path of the job.

**Table 5** Data structure description of **Script**
Parameter	Mandatory	Type	Description
name	Yes	String	Script name.
path	Yes	String	Path of the script.

**Table 6** Data structure description of **Resource**
Parameter	Mandatory	Type	Description
name	Yes	String	Name of the resource.
status	Yes	Int	Resource status. 0 indicates that the resource does not exist; 1 indicates that the resource exists.
type	Yes	String	Resource type. DWS_CLUSTER DWS_CONNECTION DLI_QUEUE DLI_CONNECTION CDM_CLUSTER GES_GRAPH

Example

View the parameter definitions in the job file on OBS.

Request

POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/check-file
{
"path": "obs://aaaaa/DLF_myJob.zip"
}

Success response

{
    "jobs":[
        {
            "name":"test",
            "path":"/test",
            "params":{
                "ddd":"dddd"
            }
        },
        {
            "name":"test1",
            "path":"/test",
            "params":{
                "ddd":"dddd"
            }
        }
    ],
    "scripts":[
        {
            "name":"script1",
            "path":"/path1"
        },
        {
            "name":"script2",
            "path":"/path1"
        }
    ]
}

Failure response

HTTP status code 400

{
    "error_code":"DLF.0815",
    "error_msg":"Fail to read OBS file."
}

Status Codes

See Status Codes.

Parent topic: Job Development APIs

Previous topic: Job Development APIs

Next topic: Stopping a Job

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot