Deleting a Job

Function

This API is used to delete a job.

URI

• URI format

  DELETE /v1/{project_id}/jobs/{job_name}

• 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
approvers	No	List<JobApprover>	Job approver. This parameter is required if the review function is enabled. For details, see Table 4.

Table 4 Approver attributes

Parameter	Mandatory	Type	Description
approverName	Yes	String	Approver name

Response Parameters

None.

Example Request

DELETE /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/joba

Delete a job when the review function is enabled.

DELETE /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/joba
{
  "approvers": [
    {
      "approverName": "userName1"
    },
    {
      "approverName": "userName2"
    }
  ]
}

Example Response

• Response

  HTTP status code 204

• Failure response

  HTTP status code 400

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

Status Codes

See Status Codes.

last updated: 2024-11-13 13:47 UTC - commit: db9c60a6c98025320fa32706a5e58cd02cf7d7f1