Webhook アドレスの取得

この記事では、DingTalk、Lark、Slack、および Telegram ボットの Webhook アドレスの取得方法と、OceanBase Cloud でのカスタム URL の設定方法について説明します。

DingTalk グループボットの Webhook アドレスの取得

DingTalk グループボットを取得する手順は以下のとおりです。

1. DingTalk クライアントを開き、アラート通知を送信したいグループに入ります。

2. グループ設定 > グループ管理 > ボット > ボットの追加 をクリックします。

3. カスタムボット を選択します。

4. ボットの詳細ページで、追加 をクリックします。

5. ボットの追加ページで、関連パラメータを入力します。

   パラメータ	説明
   ボット名	グループ内で表示されるボットの名前です。
   グループへの追加	デフォルトでは現在のグループが選択されています。
   セキュリティ設定	OceanBase Cloud のアラートを受信する場合は、カスタムキーワードによるセキュリティ設定を使用してください。 説明 カスタムキーワードは OceanBase、OB、OBCloud、test に設定することを推奨します。これにより、OceanBase のアラートを正常に受信できます。

6. 「カスタムボットサービスおよび免責事項」 を確認してチェックを入れ、完了 をクリックします。

7. グループ管理 > ボット に戻り、作成したカスタムボットを選択して Webhook アドレスをコピーします。

   説明

   Webhook アドレスは適切に保管し、GitLab やブログなどの公開サイトに掲載しないでください。アドレスの漏洩による不正な呼び出しを防ぐためです。

Lark グループボットの Webhook アドレスの取得

Lark グループボットを取得する手順は以下のとおりです。

1. Lark クライアントを開き、対象のグループに入ります。

2. グループの右上にあるその他のボタンをクリックし、設定 をクリックします。右側の設定画面で、グループボット > ボットの追加 を順にクリックします。

3. カスタムボット を選択します。

4. カスタムボットの アバター、名前、説明 を設定し、追加 をクリックします。

5. Webhook アドレスをコピーし、完了 をクリックします。

   説明

   Webhook アドレスは適切に保管し、GitLab やブログなどの公開サイトに掲載しないでください。アドレスの漏洩による不正な呼び出しを防ぐためです。

6. 任意：カスタムボットの詳細ページを開き、セキュリティ設定を行います。

   パラメータ	説明
   Webhook アドレス	このボットの Webhook アドレスをコピーできます。
   セキュリティ設定	OceanBase Cloud のアラートを受信する場合は、カスタムキーワードによるセキュリティ設定を使用してください。 説明 カスタムキーワードは OceanBase と OB に設定することを推奨します。これにより、OceanBase Cloud のアラートを正常に受信できます。
   設定	ボットの管理権限を設定します。

Telegram ボット

以下の手順に従って、Telegram ボットの Webhook アドレスを取得し、OceanBase Cloud に設定します。

1. アラート受信用の Telegram ボットを作成します。

   1. Telegram の検索バーで @BotFather を検索し、チャット画面を開きます。

   2. /newbot と入力し、プロンプトに従ってボットの表示名とユーザー名を設定します。

   3. ボットの作成が完了したら、ボットのユーザー名と BotFather から発行された API Token を控えておきます。

      説明

      API Token は適切に保管してください。この Token を入手した第三者はボットを完全に制御できます。

2. グループチャット ID を取得します。

   1. グループチャットを作成し、先ほど作成したボットを検索して追加します。

   2. グループチャット内で、ボットが受信できるコマンド（例：/start@<bot_username>）を送信します。<bot_username> はボットのユーザー名に置き換えてください。

   3. Telegram クライアントではグループチャット ID が表示されないため、ブラウザで Bot API を使用して確認します。

      1. ブラウザのアドレスバーに以下の URL を入力し、ボットが受信した最新の更新情報を取得します。

         URL 形式：https://api.telegram.org/bot<token>/getUpdates。<token> はボット作成時に取得した API Token に置き換えます。

         URL 例：https://api.telegram.org/bot123456:ABC-DEF1234ghIkl-zyx57W2v1********/getUpdates

         説明

         ボットに Telegram outgoing webhook が設定されている場合、getUpdates は使用できません。

      2. 返される JSON データから result[].message.chat.id を探します。この値がグループチャット ID です。

         説明

         グループチャットがスーパーグループにアップグレードされると、チャット ID が変わる場合があります。変更された場合は再度取得してください。

3. Webhook アドレスを生成します。

   以下の形式で Webhook アドレスを生成します。<token> はボットの API Token に、<chat_id> はグループチャット ID に置き換えます。OceanBase Cloud が Telegram Bot API を呼び出す際、アラートメッセージの内容は自動的に挿入されます。

   https://api.telegram.org/bot<token>/sendMessage?chat_id=<chat_id>
   

   例：

   https://api.telegram.org/bot123456:ABC-DEF1234ghIkl-zyx57W2v1********/sendMessage?chat_id=-45********
   

4. Telegram Webhook を OceanBase Cloud に設定します。

   1. アラート連絡先の作成または編集画面の Webhook セクションで、Telegram を選択します。
   2. 前の手順で生成した Webhook アドレスを入力し、テスト をクリックします。
   3. テストが成功したら、通知言語を選択してアラート連絡先を保存します。

Slack ボット

以下の手順に従って、Slack ボットの Webhook アドレスを取得し、OceanBase Cloud に設定します。

1. Slack アプリ管理ページにアクセスし、Create New App をクリックします。

2. From scratch を選択し、アプリ名を入力して対象のワークスペースを選択してから、Create をクリックします。

3. 左側のナビゲーションバーで Incoming Webhooks を選択し、Activate Incoming Webhooks を有効にします。

4. Add New Webhook to Workspace をクリックします。

5. アラートを受信するチャンネルを選択し、Authorize をクリックします。プライベートチャンネルを選択する場合は、そのチャンネルに参加していることを確認してください。

6. Webhook URLs for Your Workspace セクションで、生成された Webhook アドレスをコピーします。

   説明

   Webhook アドレスは適切に保管し、公開サイトやパブリックコードリポジトリに公開しないでください。

7. OceanBase Cloud のアラート連絡先の作成または編集画面で、Slack を選択し、Webhook アドレスを入力してから テスト をクリックします。

8. テストが成功したら、通知言語を選択してアラート連絡先を保存します。

カスタム URL

アラート連絡先を作成または編集する際、以下の手順でカスタム Webhook アドレスを設定します。

1. Webhook セクションで カスタム URL を選択します。

2. Webhook アドレスを入力し、必要に応じて以下の設定を行います。

   パラメータ	設定
   HTTP ヘッダー	HTTP リクエストヘッダー名と値を入力します。複数のヘッダーを追加できます。例：API-Key: ******、Content-Type: application/json;charset=UTF-8
   リクエストメソッド	POST または PUT を選択します。
   成功レスポンス検証ルール	HTTP リクエストが正常に送信されたかどうかを判定するためのルールです。ID、タイムスタンプ、traceId、トランザクション番号などの動的フィールドは入力しないでください。システムはレスポンスの内容を読み取って検証を行います。JSON レスポンスの場合、固定フィールドを指定します（例：{"code":"SUCCESS"}）。レスポンスにこのキーと値のペアが含まれていれば成功とみなされます。JSON 以外のレスポンスの場合、正規表現を指定し、レスポンスの内容がそのパターンに一致すれば成功とみなされます。

3. テスト をクリックします。テストが成功したら、通知言語を選択してアラート連絡先を保存します。