订阅管理支持主动配置订阅规则，获取任务的变更状态，并支持多种任务筛选条件及订阅者类型的设置。
目前，订阅管理已支持以下订阅需求，同时还可以开启高级设置，按需自定义订阅消息内容，包括任务描述、提交说明、自定义默认信息等。

• 支持任务上线、开启/重启、关闭/停止、发布包创建、删除事件的订阅。
• 提供指定任务条件、指定任务名称、全部任务三种任务筛选条件。
• 支持用户、邮箱、应用(webhook）、责任人四种接收消息的订阅者类型。

适用场景 #

订阅管理主要适用场景举例说明如下：

• 场景1：关注核心任务/上游依赖任务的代码变更
  • 作为项目管理者，关心团队内核心任务代码是否发生变更，以评估对生产的影响。希望可以通过邮件接收任务上线的通知，主动查看变更内容。
  • 作为下游任务的开发者，关心上游依赖任务是否发生变更，以评估对下游的影响。希望可以主动获取任务上线的通知，查看变更内容。
  • 团队内定义了较严格的研发规范，需要团队内每位同学都可以关注到项目下任务代码变更。希望可以通过邮件接收任务上线的消息，方便每位同学了解任务变更。
• 场景2：获取任务状态变更消息并进行二次分析
  作为业务事故归因平台，需要获取多个项目下的任务代码变更的消息，作为事故归因的输入。希望可以主动获取多个项目下任务的上线变更通知，并进行分析。

使用限制 #

• 权限限制
  仅当前项目下被授予管理员、开发或复查人角色的用户可创建、查看、编辑和删除订阅管理，被授予访客或受限开发角色的用户仅可查看。
• 订阅对象限制
  订阅对象仅支持选择当前项目下的任务，不支持跨项目的任务变更状态订阅。若需要获取其他项目的任务变更状态消息，可联系任务的责任人创建订阅规则，并将您添加为订阅者。
• 订阅者限制
  当订阅者选择用户时，会将该订阅信息通过飞书消息方式发送给使用飞书账号登录的用户。

订阅管理 #

通过增、删、改、查操作，实现对订阅规则的管理，步骤如下：

1. 登录DataLeap控制台。

2. 选择数据开发 > 发布中心 > 订阅管理，进入订阅管理界面。
   

3. 在订阅管理界面，单击右上角新建订阅按钮，并完成以下订阅规则配置：

   参数	说明
   订阅名称	设定的订阅规则的命名。项目下订阅名称唯一。 支持中文、英文、数字及下划线，且不超过50个字符。
   描述	对该订阅规则的描述信息，不超200个字符。
   订阅实体	订阅实体对象，可支持选择任务、发布包、实例、回溯。
   订阅范围	针对不同的订阅实体对象，设置订阅的范围，其中订阅范围选择部分订阅实体时，可根据任务名称、任务类型、任务标签、任务优先级、责任人、存储目录等进行筛选部分订阅实体。 支持添加多个订阅范围，多个订阅范围可按需选择且/或的关系。
   订阅事件	订阅实体为任务时：支持上线、开启/重启、关闭/停止、删除、修改队列，这几类事件。 订阅实体为发布包时：支持发布包创建事件订阅。 订阅实体为实例时：支持实例状态变更事件订阅。 订阅实体为回溯时：支持回溯进度变更事件订阅。
   订阅者	支持用户、邮箱、应用（webhook）、责任人四种订阅者身份。 说明 订阅者对象为用户、责任人，需满足以下两个条件，方可通过飞书来接收订阅消息： 在DataLeap管理控制台的报警接收渠道配置中，已接入飞书相关平台，并已添加相应的飞书消息通知机器人信息，详见“报警接收渠道配置”。 用户、责任人其账号信息需为飞书授权登录DataLeap控制台后自动创建，用户名为飞书邮箱前缀。
   语言	您可选择订阅消息发送的语言类型，当订阅者对象为用户或责任人时，订阅消息可发送至飞书，其语言类型需基于飞书客户端设置中的语言类型选择。
   推送时间	目前仅支持立即推送一种方式。
   高级设置	可选择开启或关闭。 开启后，可自定义订阅消息扩展内容。 当description值为true时，可订阅任务描述，默认为false。 当commitDescription值为true时，可订阅任务提交说明，默认为false。 defaultInfo表示自定义的消息内容，如团队代码发布规范等。

4. 订阅信息配置完成后，单击保存按钮，完成订阅创建。

5. 订阅创建完成后，您可按需执行以下操作：

   • 搜索订阅
     支持按照内容、订阅对象、订阅者及订阅事件进行搜索。
     • 内容搜索：订阅规则名称或ID。
     • 订阅对象：仅支持按照所输入的字符串进行直接的匹配，不判断“包含”、“不包含”等复杂条件。
     • 订阅用户/飞书群/应用：支持按照用户、飞书群、应用（webhook）进行搜索。
     • 订阅事件：支持任务上线、开启/重启、关闭/停止、发布包创建、删除几类事件。
   • 编辑订阅
     单击列表中某条信息操作列的编辑按钮，修改订阅名称、描述、订阅对象、订阅事件或订阅者等，单击保存按钮，即可完成该订阅规则的编辑。
   • 删除订阅
     单击列表中某条信息操作列的删除按钮，在弹出的确认对话框中，单击删除按钮，即可完成该订阅规则的删除。

补充说明 #

当订阅者选择应用时，可以添加webhook url，系统会通过post请求调用webhook url，推送订阅消息。Webhook url回传数据格式说明如下。

• webhook回调
  webhookUrl为post类型，且必须添加http或https协议头，请求header中content-type默认为Content-Type: application/json

• body格式举例

  {
  "subscribeName": ["订阅规则名称1","订阅规则名称2"],
  "name":"",
  "id":"",
  "type":"",
  "event":"",
  "operator":"",
  "time":"",
  "detail":"",
  "description":"",
  "commitDescription":"",
  "defaultInfo":""
  }
  

• body字段说明

  字段名	类型	说明
  subscribeName	String	订阅规则名称
  name	String	任务名称
  id	Long	任务ID
  type	String	任务类型
  event	String	订阅事件类型
  operator	String	触发事件的操作人
  time	String	消息发送时间
  detail	String	事件明细内容的链接
  description	String	任务的描述信息
  commitDescription	String	任务的提交说明
  defaultInfo	String	自定义的描述信息