文档首页/ 流水线 CodeArts Pipeline/ API参考/ API/ 流水线管理/ 流水线消息通知开关
更新时间：2024-08-22 GMT+08:00
在线调试
CLI示例
查看PDF
分享

流水线消息通知开关

功能介绍

流水线消息通知开关

调用方法

请参见如何调用API。

URI

POST /v5/{project_id}/api/pipeline-notices/{pipeline_id}/notice/all

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释： CodeArts项目ID。 约束限制： 不涉及 取值范围： 32位字符。 默认取值： 不涉及。

pipeline_id

是

String

参数解释： 流水线ID。 约束限制： 不涉及 取值范围： 32位字符。 默认取值： 不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

notice_type

是

String

通知类型

notice_switch

是

Boolean

开关状态

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

status

String

状态

请求示例

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

{
  "notice_type" : "officialNotice",
  "notice_switch" : false
}

响应示例

状态码： 200

响应体

{
  "status" : "success"
}

状态码

状态码

描述

200

响应体

错误码

请参见错误码。

父主题： 流水线管理

相关文档