Help Center/ DataArts Studio/ API Reference/ DataArts Factory APIs/ Job Development APIs/ Stopping a Job
Updated on 2025-11-17 GMT+08:00
View PDF

Stopping a Job

Function

This API is used to stop a job.

URI

  • URI format

    POST /v1/{project_id}/jobs/{job_name}/stop

  • 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.
    NOTE:
    • You need to specify a workspace for multiple DataArts Studio instances.
    • This parameter is mandatory if no default workspace is available. If you do not set it, an error is reported.

Response Parameters

None.

Example Request

Stops job myJob. 
POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/myJob/stop

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