文档首页/ 流水线 CodeArts Pipeline/ API参考/ API/ 流水线管理/ 禁用流水线
更新时间：2025-08-19 GMT+08:00
在线调试
CLI示例
查看PDF
分享

禁用流水线

功能介绍

禁用流水线

调用方法

请参见如何调用API。

URI

PUT /v5/{project_id}/api/pipelines/{pipeline_id}/ban

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，获取方式请参见获取项目ID。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

pipeline_id

是

String

参数解释：

流水线ID，可以通过查询流水线列表接口获取，其中pipelines.pipelineId即为流水线ID。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

-

Boolean

参数解释：

是否禁用成功。

取值范围：

  • true：禁用成功。

  • false：禁用失败。

状态码：400

表3 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

请求示例

PUT https://{endpoint}}/v5/db8d07265e24426598b3eb03a7818972/api/pipelines/a9278e7a9f394dacb07ab2529df7c201/ban

响应示例

状态码：200

禁用流水线响应体

true

状态码

状态码

描述

200

禁用流水线响应体

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。

父主题： 流水线管理

相关文档