建立推送通道

更新時間:
Copy as MD

本篇文檔介紹如何建立推送通道。

建立推送通道

  1. 專案 > 訊息 中,單擊 推送通道 > 建立推送通道

    image

  2. 建立推送通道 頁面中配置通道資訊。

    image

    資訊項

    說明

    通道名稱

    自訂通道名稱。

    通道類型

    擷取 Webhook 地址:

    添加DingTalk/飛書機器人時,安全設定 對話方塊中的 自訂關鍵詞 必須為 ODC。

    image

    簽名密鑰

    DingTalk機器人加簽密鑰。

    指定使用者

    使用者手機號。

    推送訊息模版

    選擇推送訊息語言類型。

    訊息限流設定

    設定在規定時間內推送訊息次數。

    描述

    支援輸入不超過 200 個字元的描述資訊,該項為選填項。

  3. 如上圖所示,單擊 發送測試訊息,測試訊息發送成功後,單擊 建立

    image

通道類型

ODC 支援通過DingTalk/飛書/企業微信/自訂方式推送訊息:

通道類型

配置項

DingTalk

  • 擷取DingTalk機器人Webhook地址

  • 簽名密鑰:DingTalk機器人加簽密鑰。

  • 指定使用者:使用者手機號。

  • 訊息模版:支援簡體中文/繁體中文/英文。

  • 訊息限流設定:設定在規定時間內推送訊息次數。

飛書

  • 飛書 Webhook 地址

  • 簽名密鑰:飛書機器人加簽密鑰。

  • 訊息模版:支援簡體中文/繁體中文/英文。

  • 訊息限流設定:設定在規定時間內推送訊息次數。

企業微信

  • 企業微信機器人

  • 指定使用者:使用者手機號。

  • 訊息模版:支援簡體中文/繁體中文/英文。

  • 訊息限流設定:設定在規定時間內推送訊息次數。

自訂

  • Webhook 地址。

  • 代理:Proxy 伺服器地址,格式為 http://ip:port。

  • 要求方法:POST/GET/PUT,預設為 POST。

  • 訊息模版:支援簡體中文/繁體中文/英文。

  • 訊息限流設定:設定在規定時間內推送訊息次數。

訊息模板

ODC 支援專案成員自訂簡體中文/繁體中文/英文類型訊息模板。預設為 Markdown 格式的訊息模板。

  • 簡體中文

    ### ODC ${taskType}-${taskStatus}
     - 任務ID: ${taskId}
     - 專案: ${projectName}
     - 資料庫: ${databaseName}
     - 發起人: ${creatorName}
     - 觸發時間: ${triggerTime}
    
  • 繁體中文

    ### ODC ${taskType}-${taskStatus}
     - 任務ID: ${taskId}
     - 項目: ${projectName}
     - 數據庫: ${databaseName}
     - 發起人: ${creatorName}
     - 觸發時間: ${triggerTime}
    
  • 英文

    ### ODC ${taskType}-${taskStatus}
     - task ID: ${taskId}
     - project: ${projectName}
     - database: ${databaseName}
     - creator: ${creatorName}
     - trigger time: ${triggerTime}
    

    支援的標籤:

    標籤名稱

    說明

    region

    OceanBase region。

    taskType

    任務類型。

    taskStatus

    任務狀態。

    projectId

    專案 ID。

    projectName

    專案名。

    creatorId

    發起人 ID。

    creatorName

    發起人使用者名稱。

    taskId

    任務 ID。

    connectionId

    資料來源 ID。

    databaseId

    資料庫 ID。

    databaseName

    資料庫名。

    clusterName

    叢集名。

    tenantName

    租戶名。

    environment

    資料來源環境。

    triggerTime

    事件觸發時間。

    message

    訊息體。

    title

    訊息標題。

    approverId

    審批人 ID。

    approverName

    審批人使用者名稱。

    description

    工單描述。

    ticketUrl

    工單連結。ODC 網域名稱擷取方法如下,優先順序從高到低:

    1. 中繼資料庫 config_system_configuration 表中 odc.site.url 對應的配置項。

    2. ODC Server IP。

訊息限流設定

部分推送平台存在發送訊息頻率限制,例如DingTalk自訂機器人每分鐘最多發送二十條推送,若超過此上限,機器人會被限流十分鐘。此外,如果短時間內收到大量推送訊息,可能會導致重要訊息被淹沒。

因此 ODC 提供了訊息限流功能,可以配置每分鐘/每小時/每天某個通道推送的上限。可以通過下述方式處理超出限流配置後的消:

  • 忽略:忽略已超出限流的訊息,不再重發,此時 推送記錄 介面對應訊息的狀態為 忽略

  • 重發:限流時間過後,將自動重發超出限流的訊息,在重發之前的推送狀態為 待發送

相關文檔