準拠通知の送信

API Governance コンソールまたは Anypoint CLI を使用して通知を設定することで、通知を自動的に送信できます。API Governance コンソールからメールを手動で送信することもできます。

各メール通知には次のコンテンツが含まれます。

自動準拠通知を送信する

API の最新バージョンが非準拠になったときにメールを自動的に送信するように、通知を有効にして設定します。

通知は、選択した受信者で設定されている有効な連絡先メールアドレスがある場合にのみ送信されます。

検証中に準拠状況が変化すると、新しい準拠エラーが発生した各ルールセットに対して自動通知が送信されます。API のそのバージョンが初めて特定のルールセットに準拠しなかった API についてのみ通知が送信されます。

通知が送信される可能性がある変更は次のとおりです。

コンソールで準拠通知を有効にして設定する手順は、次のとおりです。

API Governance コンソールで、プロファイルの作成または更新中に、[Next (次へ)] ボタンと [前へ] ボタンを使用して、通知を有効にするプロファイルの [Notifications (通知)] ページに移動します。
まだ選択していない場合は、[Nonconformance notification (非準拠通知)] の [Enabled (有効)] を選択します。
受信者を選択します。
- API Publisher (API パブリッシャー): リストされている Anypoint Platform アカウントで指定されたメールアドレスを使用して、API パブリッシャーにメールを送信
- API Contact (API 連絡先): Exchange のアセットで指定された連絡先にメールを送信
- Others (その他): メールアドレスのカンマ区切りのリストにメールを送信

CLI を使用して準拠通知を有効にして設定するには、governance create profile または governance update profile コマンドを使用してプロファイルを作成または更新するときに次のオプションを使用します。

--notify-publisher
--notify-contact
--notify-others a@a.a,b@b.com

--notify-off オプションと共に governance update profile コマンドを使用して通知を無効にできます。

何らかの理由で API オーナーに手動で通知する場合 (API が準拠していない場合や、プロファイルを変更した場合など)、直接メール通知を送信できます。

API オーナーに通知メールを手動で送信する手順は、次のとおりです。

API Governance コンソールで、次の操作を実行します。
- プロファイルから API オーナーに通知メールを送信するには、ガバナンスプロファイルを選択する。
- 特定の API の準拠に関する通知メールを送信するには、[APIs (API)] タブを選択し、その API の概要行でアクションを表示する。
[Notify Owner (オーナーに通知)] アイコンをクリックします。
受信者を選択します。
- API Publisher (API パブリッシャー): リストされている Anypoint Platform アカウントで指定されたメールアドレスを使用して、API パブリッシャーにメールを送信
- API Contact (API 連絡先): Exchange のアセットで指定された連絡先にメールを送信
- Others (その他): メールアドレスのカンマ区切りのリストにメールを送信
メールのテキストを確認し、[Notify Owner (オーナーに通知)] をクリックします。