すべてのプロダクト
Search
ドキュメントセンター

ApsaraDB for OceanBase:カスタムチャネルを構成する

最終更新日:Jan 19, 2025

このトピックでは、カスタムチャネルを構成する方法について説明します。

パラメーター

次の表は、[チャネルの種類][HTTP] の場合に指定するパラメーターについて説明します。

パラメーター

説明

Webhook URL

通知を受信するための宛先 URL。 http:// または https:// で始まる必要があります。

プロキシ (オプション)

通知を送信するプロキシサーバー。 http://ip:port の形式です。この形式では、ip はプロキシサーバーの IP アドレスを表し、port は通知を送信するために割り当てられたポートを表します。たとえば、プロキシサーバーの IP アドレスが xxx.xxx.xxx.xxx で、ポート 80 が割り当てられている場合、プロキシhttp://xxx.xxx.xxx.xxx:80 に設定できます。

リクエストメソッド

必要に応じてリクエストメソッドを選択します。デフォルト値は POST です。

ヘッダー

HTTP ヘッダーのテンプレートを入力します。パラメーターはセミコロン(;)で区切ります。たとえば、Content-Type:application/json;charset:utf-8 です。

本文

通知コンテンツのテンプレートを指定します。このパラメーターが指定されていない場合、HTTP 本文は使用されません。テンプレートを使用して変数を参照できます。変数のリストについては、「通知チャネルを作成する」をご参照ください。

応答検証

応答はチャネルによって異なります。ODC が通知が正常に送信されたかどうかを正確に判断するために、応答検証情報を構成する必要があります。

  • 応答検証情報は JSON 文字列として入力する必要があります。ODC は JSON 文字列のフィールドを解析し、チャネル応答の本文にある対応する情報と照合します。すべてのフィールドが正常に一致した場合、ODC は通知が正常に送信されたと判断します。

  • チャネル応答が不明な場合は、{} に設定できます。こうすることで、ODC は常に通知が正常に送信されたとみなします。

image

前の図に示すように、イベントに対応するタスク ID が 10001 の場合、ODC は指定された Webhook に次のようなリクエストを送信します。data フィールドの値は、生成された通知です。

curl -XPOST -H "Context-Type:application/json" -H "charset:utf-8" -H "appkey:xxxxxx" http://xxx.xxx.xxx.xxx:80 -d '{"jsonrpc":"2.0","params":{"output":"extend"},"auth":"*******","data":"...","task_id":"10001"}'

受信した応答にキーと値のペア "message":" success" が含まれている場合、ODC は通知が正常に送信されたと見なします。

参照