Code Pipeline
Code Pipeline
Code Pipeline
Document
Product updates
Product billing
User guide
AI application
DeepSeek
Stable Diffusion ComfyUI
Stable Diffusion WebUI
Qwen
Permission management
Code source
Pipeline
YAML pipeline
Trigger
Trigger FAQs
Variable management
Concurrency lock
Service connection
Predefined pipeline tasks
General task configuration
Compilation and build
Command execution
Build and push images
Deployments
Artifact management
Process control
Build ECS images
Custom pipeline steps
Custom pipeline templates
Application delivery (K8s YAML and OAM)
Member management
Application management
Application orchestration
Configuration management
Environment management
Deployment, operations, and maintenance
Template management (OAM)
Component templates
Plugin templates
Managed applications (K8s)
Create a managed Java application
Create a hosted application (other)
Scaling and resizing
Access methods
Hosted applications (ECS)
Resource management
Deploy resource
Build resource pool
Host group management
Best practices
FAQs
General FAQ
Code source FAQ
Compilation FAQ
Image build FAQ
Deployment FAQs
Private resource pool FAQ
Pipeline caches FAQ
Application delivery FAQ
API Reference
Methods of invocation
Pipeline
The pipeline operation
Custom steps
Service connection
Managed App
SDK reference
- Documentation
Code PipelineAPI ReferenceThe pipeline operationCancelPipelineRun
Copy page
Download PDFThe pipeline operation
CancelPipelineRun
Copy pageDownload PDFCancelPipelineRun
Cancel the running pipeline
Request description
To achieve low latency, it is recommended that you select the corresponding service address based on the Region where your resources are located. For details, see Service address.
- Request method: POST
- Request URL: https://cp.cn-beijing.volcengineapi.com?Action=CancelPipelineRun&Version=2023-05-01
Request parameters
Parameter | Type | Required | Sample Value | Description |
Action | String | Yes | CancelPipelineRun | The API name. The name of the current API is CancelPipelineRun. |
Version | String | Yes | 2023-05-01 | The API version. The current version of the API is 2023-05-01. |
WorkspaceId | String | Yes | 60cb460122422352a334**** | The workspace ID. |
PipelineId | String | Yes | c3afa3f27d754ac8b6052bf3dc0b**** | Pipeline ID. |
Id | String | Yes | c9020f1a904c41e4bc25afc96316**** | Pipeline run ID. |
Sample requests
POST https://cp.cn-beijing.volcengineapi.com?Action=CancelPipelineRun&Version=2023-05-01 HTTP/1.1
Content-Type: application/json
{
"WorkspaceId": "60cb460122422352a334****",
"PipelineId": "c3afa3f27d754ac8b6052bf3dc0b****",
"Id": "c9020f1a904c41e4bc25afc96316****"
}
Response parameters
This API does not have any unique return parameters.
Sample response
HTTP/1.1 200 OK
Content-Type: application/json
{
"ResponseMetadata": {
"RequestId": "202404071710430739950998FB2847****",
"Action": "CancelPipelineRun",
"Version": "2023-05-01",
"Service": "cp",
"Region": "cn-beijing"
},
"Result": {}
}
Error code
This API currently does not have independent error codes. If an exception occurs when calling the API, you can refer to common error codes for troubleshooting.
Last updated: 2025.09.10 17:37:28
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
