CancelPipelineRun--持续交付-火山引擎

文档中心

立即注册

导航

持续交付

CancelPipelineRun

最近更新时间：2024.07.02 21:03:13首次发布时间：2024.07.02 21:03:13

取消运行流水线。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=CancelPipelineRun&Version=2023-05-01

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	CancelPipelineRun	公共参数，本接口值：CancelPipelineRun。
Version	String	是	2023-05-01	公共参数，本接口值：2023-05-01。
WorkspaceId	String	是	60cb460122422352a334****	工作区 ID。
PipelineId	String	是	c3afa3f27d754ac8b6052bf3dc0b****	流水线 ID。
Id	String	否	c9020f1a904c41e4bc25afc96316****	流水线运行 ID。

请求示例

POST /?Action=CancelPipelineRun&Version=2023-05-01 HTTP/1.1
Content-Type:application/json
{
  "WorkspaceId": "60cb460122422352a334****",
  "PipelineId": "c3afa3f27d754ac8b6052bf3dc0b****",
  "Id": "c9020f1a904c41e4bc25afc96316****"
}

返回参数

本接口无特有的返回参数。

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202404071710430739950998FB2847****",
        "Action": "CancelPipelineRun",
        "Version": "2023-05-01",
        "Service": "cp",
        "Region": "cn-beijing"
    },
    "Result": {}
}

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。