Xiong, Chen Xiao 14a6d65e8c DataArts API 20240130 version

Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>
Co-committed-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>

2024-03-01 11:46:15 +00:00

14 KiB

Raw Permalink Blame History

Starting a Job

Function

This API is used to start a job.

URI

URI format
POST /v1/{project_id}/jobs/{job_name}/start

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.

**Table 3** Parameters
Parameter	Mandatory	Type	Description
jobParams	No	List<JobParam>	Parameter for starting the job

**Table 4** JobParam data structure description
Parameter	Mandatory	Type	Description
name	Yes	String	Name of the parameter. It cannot exceed 64 characters.
value	Yes	String	Value of the parameter. It cannot exceed 1,024 characters.
paramType	No	String	Parameter type variable constants

Response Parameters

None.

Example Request

Start job myJob.

POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/myJob/start

Example Response

Success response
HTTP status code 204

Failure response

HTTP status code 400

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

Parent topic: Job Development APIs

14 KiB Raw Permalink Blame History

Starting a Job

Function

URI

Request Parameters

Response Parameters

Example Request

Example Response

14 KiB

Raw Permalink Blame History