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
- 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
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
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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
params |
No |
Map<String,String> |
Job parameter. |
name |
Yes |
String |
Job name. |
path |
Yes |
String |
Path of the job. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Script name. |
path |
Yes |
String |
Path of the script. |
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.
|
Example Request
Query the parameter definitions in the job file on OBS.
- Request
POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/check-file { "path": "obs://aaaaa/DLF_myJob.zip" }
Example Response
- 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" } ] }
Status Codes
See Status Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.