Deleting a Build Task

Function

This API is used to delete a build task.

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	Definition Enter the ID of the build task whose history you want to query. To obtain this ID, open the build task details page in your browser, and copy the 32-character string, which includes both digits and letters, at the end of the URL. Constraints N/A. Range The value is 32 characters long. Only letters and digits are allowed. Default Value N/A.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. (The value of the X-Subject-Token response header is the user token.) It is obtained by calling the IAM API. Constraints Global tenant tokens are not supported. Use a region-level token whose scope is project. Range N/A. Default Value N/A.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
result	result object	Definition Data returned after the API is successfully called. Range N/A.
status	String	Definition Status information. Range N/A.

**Table 4** result
Parameter	Type	Description
job_id	String	Definition Build task ID. Range N/A.
project_id	String	Definition CodeArts project ID. ID of the project to which the build task belongs. Range N/A.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 404

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

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

Example Responses

Status code: 200

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