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

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

pipeline_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

type

否

Integer

参数解释：

流水线消息通知类型。

约束限制：

不涉及。

取值范围：

• 1：站内信。

• 2：邮件通知。

• 3：微信。

• 4：钉钉。

• 5：飞书。

• 6：通用webhook。

默认取值：

不涉及。

event

否

EventStatusDTO object

参数解释：

第三方通知事件配置。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

webhook_config

否

ThirdPartEventDTO object

参数解释：

第三方通知事件配置。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

id

否

String

参数解释：

事件类型。

约束限制：

不涉及。

取值范围：

• pipeline.updated：流水线配置被更新。

• pipeline.deleted：流水线被删除。

• pipelineRun.succeed：流水线执行成功。

• pipelineRun.failed：流水线执行失败。

默认取值：

不涉及。

selected

否

Boolean

参数解释：

是否启用事件通知。

约束限制：

不涉及。

取值范围：

• true：启用通知。

• false：禁用通知。

默认取值：

不涉及。

notice_roles

否

Array of strings

参数解释：

通知对象列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

notice_id

否

String

参数解释：

第三方通知配置ID，第三方通知的唯一标识。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

url

否

String

参数解释：

第三方通知URL地址，由对应第三方平台获取。

约束限制：

URL地址只能以http://或者https://开头。

取值范围：

不涉及。

默认取值：

不涉及。

events

否

Array of strings

参数解释：

流水线事件类型。

约束限制：

不涉及。

取值范围：

• pipelineRun.succeed：已完成。

• pipelineRun.failed：失败。

• pipelineRun.pause：暂停。

• pipelineRun.suspend：挂起。

• pipelineRun.ignored：忽略。

默认取值：

不涉及。

options

否

Array of strings

参数解释：

通知内容列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

mentioned_list

否

Array of strings

参数解释：

第三方user_id列表，通过user_id使用半角逗号（,）分隔组成。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

mentioned_mobile_list

否

Array of strings

参数解释：

手机号列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

secret_info

否

String

参数解释：

加签密钥。

约束限制：

钉钉、飞书自定义机器人可以开启安全设置，若未使用加签，无需填写加签秘钥。

取值范围：

不涉及。

默认取值：

不涉及。

error

ErrorInfo object

参数解释：

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

取值范围：

不涉及。

result

Object

参数解释：

返回结果。

取值范围：

不涉及。

status

String

参数解释：

状态值。

取值范围：

不涉及。

code

String

参数解释：

错误码。

取值范围：

不涉及。

message

String

参数解释：

错误信息。

取值范围：

不涉及。

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found