Deleting the Build Task

Updated on 2023-12-06 GMT+08:00

View PDF

Function

Calling Method

For details, see Calling APIs.

URI

POST /v3/jobs/{job_id}/delete

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
job_id	Yes	String	Indicates the ID of the build task. The value is a string of 32 characters consisting of digits and letters at the end of the browser URL when you edit the build task file.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. Obtain the value by calling the IAM service interface. (value of X-Subject-Token in the response header). Global tenant tokens are not supported. Use a region-level token whose scope is project.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
result	result object	Result
status	String	Status Information

**Table 4** result
Parameter	Type	Description
job_id	String	Build task ID.
project_id	String	ID of the project to which the build task belongs.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	Description

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	Description

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	Description

Status code: 404

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	Description

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	Description

Example Requests

POST https://{endpoint}/v3/jobs/cb5fa20de5fd4cf8be681d4bd6fdd2f6/delete

Example Responses

Status code: 200

{
  "status" : "success",
  "result" : {
    "job_id" : "f9d6c8466d614a9788e9a0acf6c15f46",
    "project_id" : "b4d3971c3988463b865f6f920846149e"
  }
}