文档首页/ 流水线 CodeArts Pipeline/ API参考/ API/ 流水线管理/ 修改流水线实例级别消息通知配置 - UpdatePipelineNoticeConf
更新时间:2026-09-24 GMT+08:00

修改流水线实例级别消息通知配置 - UpdatePipelineNoticeConf

功能介绍

修改流水线实例级别消息通知配置

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

pipeline_id

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

type

否

String

参数解释:

消息通知类型。

约束限制:

不涉及。

取值范围:

  • 1:站内信。

  • 2:邮件通知。

  • 3:微信。

  • 4:钉钉。

  • 5:飞书。

  • 6:通用webhook。

默认取值:

不涉及。

event

否

event object

参数解释:

消息通知事件详情。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表3 event

参数

是否必选

参数类型

描述

id

否

String

参数解释:

通知事件类型标识。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

selected

否

Boolean

参数解释:

是否开启对应类型消息通知。

约束限制:

不涉及。

取值范围:

  • true:开启对应通知

  • false:未开启对应通知

默认取值:

不涉及。

notice_roles

否

Array of strings

参数解释:

消息通知发送角色列表。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

error

ErrorInfo object

参数解释:

错误信息,接口正常无报错时不返回error字段。

取值范围:

不涉及。

result

Object

参数解释:

返回结果。

取值范围:

不涉及。

status

String

参数解释:

状态值。

取值范围:

不涉及。

表5 ErrorInfo

参数

参数类型

描述

code

String

参数解释:

错误码。

取值范围:

不涉及。

message

String

参数解释:

错误信息。

取值范围:

不涉及。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释:

错误信息。

取值范围:

不涉及。

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

请求示例

PUT https://{endpoint}/v5/e2e18230a85d4d6ab0b56cb6d2246c18/api/pipeline-notices/0747d5a7099e45f69dc1d099945909a9/notice/update

{
  "type" : "2",
  "event" : {
    "id" : "pipelineRun.failed",
    "selected" : true,
    "notice_roles" : [ "CREATOR", "EXECUTOR", "COLLECTOR" ]
  }
}

响应示例

状态码:200

{
  "status" : "success"
}

状态码

状态码

描述

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。