Stopping the build task (To Be Offline)
Function
Stopping the build task (To Be Offline)
Calling Method
For details, see Calling APIs.
URI
POST /v3/jobs/stop
Request 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. |
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
job_id |
Yes |
String |
build task ID, which is a string of 32 characters consisting of digits and letters at the end of the browser URL when the build task is edited. |
build_no |
Yes |
String |
build task build ID, which starts from 1 and increases by 1 for each build. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
|---|---|---|
result |
Boolean |
Result of stopping the build |
Status code: 400
Parameter |
Type |
Description |
|---|---|---|
error_code |
String |
Error Codes |
error_msg |
String |
Description |
Status code: 401
Parameter |
Type |
Description |
|---|---|---|
error_code |
String |
Error Codes |
error_msg |
String |
Description |
Status code: 403
Parameter |
Type |
Description |
|---|---|---|
error_code |
String |
Error Codes |
error_msg |
String |
Description |
Status code: 404
Parameter |
Type |
Description |
|---|---|---|
error_code |
String |
Error Codes |
error_msg |
String |
Description |
Status code: 500
Parameter |
Type |
Description |
|---|---|---|
error_code |
String |
Error Codes |
error_msg |
String |
Description |
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
