文档中心

通知提醒

最近更新时间：2023.07.12 20:22:45

首次发布时间：2023.07.12 20:22:45

持续交付支持通过站内信、短信、邮件、Webhook、飞书机器人的方式推送流水线消息，帮助您快速了解构建部署结果，您可根据实际需要选择通知事件及通知方式。本文为您介绍如何配置流水线通知提醒。

前提条件

已创建流水线，具体操作请参见创建流水线。
站内信
火山引擎账号默认可接收站内信。子用户需联系火山引擎账号授予 SiteMessageReadOnlyAccess 策略，获取查看站内信权限。
短信
如果希望通过短信接收消息通知，请确认通知账号已配置安全手机。可前往账号管理查看手机绑定情况。
邮件
如果希望通过邮件接收消息通知，请确认通知账号已配置安全邮箱。可前往账号管理查看邮箱绑定情况。
Webhook 通知
- 飞书机器人：需提前添加飞书机器人，并准备好机器人的 hookurl 地址。具体操作可参考飞书开发者指南。
- 通用格式：需提前准备接收通知的 hookurl 地址。

使用限制

为避免频繁消息轰炸，站内信、短信、邮件具有消息接收频率的限制。详细内容请参见使用限制。

操作步骤

进入流水线的通知提醒页签。
1. 登录持续交付控制台。
2. 在左侧导航栏选择 工作区。
3. 单击目标工作区名称，进入当前工作区。
4. 在左侧导航栏选择 流水线，进入流水线页面。
5. 在流水线列表中选择目标流水线，单击 ... > 编辑，进入当前流水线的流程编排页签。
6. 单击 通知提醒，切换至通知提醒页签。

开启通知提醒开关，并配置通知事件和通知方式。支持多选，默认勾选 开始运行 和 站内信。

alt

通知事件

配置项	说明
开始运行	当流水线开始运行时，将推送消息通知。
运行成功	当流水线运行成功时，将推送消息通知。
运行失败	当流水线运行失败时，将推送消息通知。
运行终止	当流水线被人为终止运行时，将推送消息通知。

通知方式

配置项	说明
站内信	开启后，消息将推送至火山引擎的消息中心 > 运维消息。
短信	消息将通过短信的方式推送给指定用户。开启后，系统将默认通知流水线运行人，您也可以添加流水线创建人或者其他账号为接收人。对于重复的接收人账号，流水线只会通知一次。
邮件	消息将通过邮件的方式推送给指定用户。开启后，系统将默认通知流水线运行人，您也可以添加流水线创建人或者其他账号为接收人。对于重复的接收人账号，流水线只会通知一次。
Webhook 通知	消息将通过 Webhook 的方式推送给目标 URL。支持飞书机器人和通用格式两种方式，请根据需要选择。飞书机器人：将消息推送至飞书机器人。 Webhook 地址：输入飞书机器人的 hookurl 地址。通用格式：流水线将推送一条 POST 请求至目标 URL，详细内容请参见下方的 POST 请求样例。 Webhook 地址：输入需接收通知的平台或工具的 hookurl 地址。 Token：非必填，请求头中携带用于验证推送合法性。

通知内容
Webhook 通用格式通知内容为 POST 请求，其他方式的通知内容模板如下。您可以在输入框内输入自定义通知内容，长度限制在 200 个字符以内。
```
基本信息：${流水线名称}-${运行ID}
触发人：${触发人}
触发事件：${触发事件}
触发详情：${触发详情}
链接地址：${链接地址}
${自定义内容}
```

流水线通知提醒配置完毕后，单击右下角保存，保存流水线配置。

POST 请求样例

Webhook 通用格式的通知内容为 POST 请求，详细样例如下：

//流水线维度的 Webhook 通知样例

{
  "ID": "6303544fa425e9b6b7fc****",  //流水线运行ID
  "Type": "Pipeline",  //类型：流水线
  "PipelineName": "Java项目-dev",  //流水线名称
  "PipelineRecordID": "6303544fa425e9b6b7fc****",  //流水线运行记录ID
  "URL": "https://console.volcengine.com/cp/workspace/****/pipeline/****/detail/record/****",  //流水线运行记录url
  "Triggerer": {
    "AccountId": 210013****,  //火山引擎账号id
    "UserId": 107****,  //运行人id
    "Name": ""  //用户名
  },
  "Status": "Pending",  //流水线状态，取值包含 Pending, Preparing, Running, Failed, Succeeded, Timeout, Canceled
  "StageName": null,  //阶段名称
  "TaskName": null,  //任务名称
  "TaskStatus": null,  //任务状态，取值包含 Pending, Running, Succeeded, Canceled, Timeout, Waiting, Failed
  "Message": " 2022-08-22 18:02:55 开始运行",  //异常信息
  "SCM": {
    "Name": "gitee",  //代码源名称
    "URL": "https://gitee.com/****/****",  //代码源url
    "Branch": "master"  //分支名称
  },
  "Envs": [
    {
      "Key": "image",  //当前流水线的环境变量名称
      "Value": "xxx",  //变量值 
      "Dynamic": true  //为 ture 时是动态环境变量
    }
  ]
}

前提条件

使用限制

操作步骤

POST 请求样例