文档首页/ 流水线 CodeArts Pipeline/ API参考/ API/ 流水线管理/ 取消某次流水线排队
更新时间：2024-11-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

取消某次流水线排队

功能介绍

取消某次流水线排队

调用方法

请参见如何调用API。

URI

POST /v5/{project_id}/api/pipelines/{pipeline_id}/{pipelineRunId}/cancel-queuing/{id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

CodeArts项目ID。

约束限制：

不涉及

取值范围：

32位字符。

默认取值：

不涉及。

pipeline_id

是

String

参数解释：

流水线ID。

约束限制：

不涉及

取值范围：

32位字符。

默认取值：

不涉及。

pipelineRunId

是

String

流水线运行实例ID

id

是

String

流水线排队记录ID

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

body

是

Object

请求体

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

pipeline_run_id

String

参数解释：

流水线运行实例ID。

取值范围：

32位字符，仅由数字和字母组成。

请求示例

https://(endpoint)/v5/071112d87d3e4ed49130c691936202e9/api/pipelines/c173d99dbbb54626b64cf5694c0a4e8e/071112d87d3e4ed49130c691936202e9/cancel-queuing/1

响应示例

状态码： 200

返回体

{
  "pipeline_run_id" : "8173263bf6c743f4b13f65bbf62dbf2c"
}

状态码

状态码

描述

200

返回体

错误码

请参见错误码。

父主题： 流水线管理

相关文档