文档首页/流水线 CodeArts Pipeline/API参考/API/流水线管理/流水线设置消息类型通知是否启用 - UpdateNoticeStatus
更新时间：2025-12-11 GMT+08:00
在线调试
CLI示例
查看PDF
分享

流水线设置消息类型通知是否启用 - UpdateNoticeStatus

功能介绍

设置流水线具体消息类型通知是否启用

调用方法

请参见如何调用API。

URI

PUT /v5/{project_id}/api/pipeline-notices/{pipeline_id}/notice/status

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

pipeline_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

type

否

Integer

参数解释：

流水线消息通知类型。

约束限制：

不涉及。

取值范围：

  • 1：站内信。

  • 2：邮件通知。

  • 3：微信。

  • 4：钉钉。

  • 5：飞书。

  • 6：通用webhook。

默认取值：

不涉及。

enable

否

Boolean

参数解释：

是否启用通知。

约束限制：

不涉及。

取值范围：

  • true：启用通知。

  • false：禁用通知。

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

-

Boolean

参数解释：

流水线消息类型通知是否启用。

取值范围：

  • true：流水线消息类型通知启用。

  • false：流水线消息类型通知未启用。

请求示例

PUT https://(endpoint)/v5/e2e18230a85d4d6ab0b56cb6d2246c18/api/pipeline-notices/0747d5a7099e45f69dc1d099945909a9/notice/status

{
  "enable" : true,
  "type" : 3
}

响应示例

状态码：200

OK

true

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题：流水线管理