Updated on 2023-11-28 GMT+08:00
Stopping a Pipeline
Function
Stopping a Pipeline
URI
POST /v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/{pipeline_run_id}/stop
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
project_id |
Yes |
String |
Project ID. |
pipeline_id |
Yes |
String |
Pipeline ID |
pipeline_run_id |
Yes |
String |
Pipeline running instance ID |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. Can be obtained by calling the IAM API for obtaining the user token (the value of X-Subject-Token in the response header). |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
|---|---|---|
success |
Boolean |
Whether the operation is successful |
Example Requests
POST https://{endpoint}/v5/93d8e0553c20411fba06bb112b5b59af/api/pipelines/794514e0a3184e5db0a4740112deee0f/pipeline-runs/de6c9098f45a4ac58a6efc9c1b81df82/stop
Example Responses
Status code: 200
OK
{
"success" : true
}
Status Codes
Status Code |
Description |
|---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
Error Codes
See Error Codes.
Parent topic: Pipeline Management
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
The system is busy. Please try again later.
