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

Stopping a Build

Function

Stopping a Build

Calling Method

For details, see Calling APIs.

URI

POST /v3/jobs/{job_id}/{build_no}/stop

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.

build_no

Yes

Integer

build task build ID, which starts from 1 and increases by 1 for each build.

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

success

Boolean

Whether the service is stopped successfully

result

String

Response

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Example Requests

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

Example Responses

Status code: 200

OK

{
  "success" : true,
  "result" : ""
}

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.