Updated on 2025-09-22 GMT+08:00

Stopping a Build Task (Unavailable Soon)

Function

This API is used to stop a build task.

Calling Method

For details, see Calling APIs.

URI

POST /v3/jobs/stop

Request Parameters

Table 1 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.

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

job_id

Yes

String

Definition

Build task ID. It includes digits and letters. To obtain this ID, open the page for editing the build task in your browser, and copy the 32-character string at the end of the URL.

Range

N/A.

build_no

Yes

String

Definition

The build number tracks each run of the build task. This parameter starts at 1, indicating the first build. It increments by 1 for every subsequent run.

Range

N/A.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

result

Boolean

Definition

Result of the request for stopping a build.

Range

N/A.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

POST https://{endpoint}/v3/jobs/stop

{
  "job_id" : "f9d6c8466d614a9788e9a0acf6c15f46",
  "build_no" : "20"
}

Example Responses

Status code: 200

OK

{
  "result" : true
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.