Xiong, Chen Xiao f2733178cc DataArts API 20230329 version

Reviewed-by: Kacur, Michal <michal.kacur@t-systems.com>
Co-authored-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>
Co-committed-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>

2023-06-29 16:21:21 +00:00

13 KiB

Raw Blame History

Starting a Job

Function

This API is used to start a job.

URI

URI format
POST /v1/{project_id}/jobs/{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.
name	Yes	String	Job name.

Request

**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** Parameter
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 1024 characters.

Response

None.

Example

Start job myJob.

Request

POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/myJob/start

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: APIs to Be Taken Offline

13 KiB Raw Blame History

Starting a Job

Function

URI

Request

Response

Example

13 KiB

Raw Blame History