---
schema_version: "1"
id: c310d254df1ceb9c8cb4d8f92b009661e446102eb081ffdbae2cb21bccba93f7
title: Flex Gateway API アラートの使用
collection: mulesoft
version: current
locale: ja-jp
portal_url: https://docs.salesforce.com/mulesoft/current/ja-jp/gateway/1.9/flex-use-api-alerts.md
canonical_url: https://docs.mulesoft.com/jp/gateway/1.9/flex-use-api-alerts
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 139be14fb94a1459626a10cad4d4c2613e9171bb87a7285fa469ede4cd1a7097
description: MuleSoft Documentation Site
release: "1.9"
latest: false
---
# Flex Gateway API アラートの使用

API アラートを使用することで、次のような API の異常動作を知らせるためのメール通知を追加して設定できます。

- 60 秒を超える API 応答時間
- 30 秒間で 1000 件を超える API 要求

下記の​[「API アラートの追加」](#add-api-alerts)​を参照してください。

## [](#types-of-api-alerts)API アラートのタイプ

次のアラートを追加すると、それぞれの状況を通知することができます。

- Total Request Count (合計要求数): ユーザーが指定された期間で許可されている回数を超えて API にアクセスを要求する。1 ～ 999999999 の期間値を指定します。データのバーストを回避するために、期間は絶対時間 (分) 範囲ではなく、スライディングウィンドウとして実装されます。 [「スライディングウィンドウ」](https://www.techopedia.com/definition/869/sliding-window)​を参照してください。
- Average Response Time (平均応答時間): API の応答時間が指定されたタイムアウト期間を超えている。
- Response Codes (応答コード): 要求を受け取ると、API は HTTP コードの 400、401、403、404、408、500、502、503、または 3 桁のカスタムコードを返します。
- Policy Violation (ポリシー違反): API を管理するポリシーで違反が発生している。

## [](#api-アラートの仕組み)API アラートの仕組み

API アラートは以下の場合にのみトリガーされます。

- API の状態が変化した
    
    新しく作成したアラートで状態が定義されていない場合は、最初の状態の変更が検出されない可能性があります。
- アラート条件が指定期間に渡って成立した
    
    たとえば、API が HTTP コード 500 を 10 分間に 5 回以上返した場合にトリガーされるようにアラートを設定してある場合、HTTP コード 500 が 10 分間に 1 回しか返されなかったときには、そのアラートはトリガーされません。

API アラートを設定するときには、アラートに関するメール通知を受信するビジネスグループユーザーや組織外のユーザーを選択できます。通知には、重要度レベルで指定されたようにアラートをトリガーするイベントに関する情報が含まれます。

<table><tbody><tr><td class="icon"><i class="fa icon-note" title="Note"></i></td><td class="content">API アラートは ​<code>no-reply@mulesoft.com</code>​ から送信されます。これはカスタマイズできません。</td></tr></tbody></table>

- 1 つは、アラートについて説明するメールです。
    
    `Your API, CesarDemoAPI - Basic:151 (Environment: "NewOne"), has received greater than 2 requests within 1 consecutive periods of 1 minutes.`
- もう 1 つは、アラートがいつ解決されるかを通知するメールです。
    
    `Your API Version, jsonplaceholderapi - 1.0.development, is no longer in an alert state.The number of policy violations was not greater than 1 in the last 1 consecutive periods of 1 minutes.`

API Manager は、最初の 2 件の通知メールのセットを送信した後で、次のアラート期間が始まるまでアラートのリスンを停止します。この方法で反復する通知メールが防止されます。

## [](#始める前に)始める前に

アラートを表示および削除するには、次を確認してください。

- API アラートを表示および削除するための​**「Manage Alerts (アラートの管理)」**​権限。
- アラートの表示のみを行うための​**「View Alerts (アラートの表示)」**​権限。

## [](#add-api-alerts)API アラートの追加

API を追跡および管理するには、1 つ以上の API アラートを API インスタンスに追加できます。各自の要件に基づいて、さまざまな​[種別のアラート](#types-of-api-alerts)​を追加します。

次の表は、API インスタンスごとのアクティブなアラート数を示しています。

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">価格設定パッケージ</th>
<th class="tableblock halign-left valign-top">アクティブなアラート</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Anypoint Integration Starter</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">最大 6 個</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Anypoint Integration Advanced</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">最大 10 個</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Gold サブスクリプション</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">最大 6 個</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Platinum サブスクリプション</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">最大 6 個</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Titanium サブスクリプション</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">最大 10 個</p></td>
</tr>
</tbody>
</table>

すべてのサブスクリプションで、アクティブでないアラートは必要に応じて何個でも使用できます。

アクティブなアラートの最大数に達した場合は、アクティブなアラートを一時停止または削除することで、新しいアラートを作成できるようになります。

アラートは、作成時にデフォルトで有効化されます。この設定は変更できません。

<table><tbody><tr><td class="icon"><i class="fa icon-note" title="Note"></i></td><td class="content"><a href="https://docs.mulesoft.com/gateway/latest/policies-automated-overview" class="xref page">自動ポリシー</a>​で保護されている API インスタンスにはアラートを追加できません。</td></tr></tbody></table>

API アラートを追加する手順は、次のとおりです。

1. **\[API Manager\]**​ > ​**\[API Administration (API 管理)\]**​ に移動して、アラートを追加する API インスタンスをクリックします。
2. 左側のナビゲーションペインから、​**\[Alerts (アラート)\]**​ > ​**\[New alert (新規アラート)\]**​ を選択します。
3. 表示されているアラートオプションの値を指定します。
    
    - **Name (名前)**​:
        
        アラート名を入力します (例: `trial-alert`​)。不要な場合はアラートをいつでも削除できます。
    - **Severity (重要度)**​:
        
        アラートの重要度を選択します。
        
        - **Info (情報)**
            
            トリガーされた時点で直ちに対応する必要がないアラートに割り当てます。この重要度は、メトリクスを受動的に監視する必要があることを示しています。
        - **Warning (警告)**
            
            トリガーされた時点で直ちに対応する必要があるアラートに割り当てます。この重要度は、アラートを綿密に監視する必要があることを示しています。
        - **Critical (重大)**
            
            トリガーされた時点で直ちに対応する必要があるアラートに割り当てます。この重要度は、アラートに直ちに対応する必要があることを示しています。
4. アラート条件を指定します。
    
    - **Metric (メトリクス)**
        
        アラートをトリガーする条件。
    - **Logic (ロジック)**
        
        **\[When number of occurrences are (発生回数)\]**​ 項目と ​**\[For at least \[number of\] minutes (\[ \] 分以上)\]**​ 項目で定義される発生率に基づいた、アラートをトリガーするタイミング。 アラート条件には最大 10 個の応答コードを選択できます。
5. メール通知を設定します。
    
    - **Subject (件名)**
        
        アラートがトリガーされたときに送信されるアラートメールの件名。件名には変数を含めることができます。​[変数定義](#alert-variables)​を参照してください。
    - **Message (メッセージ)**
        
        アラートがトリガーされたときに送信されるメールの本文テキスト。メッセージ本文には変数を含めることができます。​[変数定義](#alert-variables)​を参照してください。
    - **Recipients (受信者)**
        
        アラートメールの受信者。最大 20 個のプラットフォームユーザー ID を選択し、最大 20 個のメールアドレスを入力できます。
6. **\[Create (作成)\]**​ をクリックします。

アラートの作成中は ​**\[Pending (保留中)\]**​ と表示されます。API がトラフィックを受け取ると、アラートの状態は ​**\[OK\]**​ に変わります。また、値に応じて、アラートは ​**\[OK\]**​ または ​**\[Alerting (アラート)\]**​ に移行します。

### [](#アラートメールテンプレート)アラートメールテンプレート

基本アラートメールの ​**\[Subject (件名)\]**​ 項目と ​**\[Message (メッセージ)\]**​ 項目で次の変数を使用できます。

各変数の説明については、​[変数定義](#alert-variables)​を参照してください。

<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 1. アラートの変数</caption>
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">アラート</th>
<th class="tableblock halign-left valign-top">該当する変数</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Total Request Count (合計要求数)</strong>​</p></td>
<td class="tableblock halign-left valign-top" rowspan="4"><div class="content"><div class="ulist">
<ul>
<li>
<p><code>${severity}</code>​</p>
</li>
<li>
<p><code>${operator}</code>​</p>
</li>
<li>
<p><code>${threshold}</code>​</p>
</li>
<li>
<p><code>${period}</code>​</p>
</li>
<li>
<p><code>${value}</code>​</p>
</li>
<li>
<p><code>${condition}</code>​</p>
</li>
<li>
<p><code>${organization}</code>​</p>
</li>
<li>
<p><code>${environment}</code>​</p>
</li>
<li>
<p><code>${apiLink}</code>​</p>
</li>
<li>
<p><code>${dashboardLink}</code>​</p>
</li>
<li>
<p><code>${api}</code>​</p>
</li>
<li>
<p><code>${policy}</code>​</p>
</li>
</ul>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Average Response Time (平均応答時間)</strong></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Response Codes (応答コード)</strong></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Policy Violations (ポリシー違反)</strong>​</p></td>
</tr>
</tbody>
</table> <table id="alert-variables" class="tableblock frame-all grid-all fit-content spread">
<caption class="title">Table 2. 変数定義</caption>
<colgroup>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">変数</th>
<th class="tableblock halign-left valign-top">定義</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>${apiLink}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">トリガーされた API の URL。</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>${alertState}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">アラートがトリガーされたときのアラートの状態。</p>
<p class="tableblock">使用可能な値は ​<code>OK</code>​ または ​<code>Alerting</code>​ です。</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>${comparison}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">* Above (上回る)、Above or equal (上回るまたは等しい)、Equal (等しい)、Below or equal (下回るまたは等しい)、Below (下回る)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>${condition}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">アラートがトリガーされるメトリクス。</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>${environment}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">リソースがデプロイされている環境の名前。</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>${operator}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>&lt; &gt; =</code>​ などの演算子。</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>${organization}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">アラートを所有する組織の名前。</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>${period}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">測定する期間。</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>${severity}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">アラートの重要度。</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>${threshold}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">アラートをトリガーする期間での数</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>${value}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">アラートをトリガーするメトリクスの値。</p></td>
</tr>
</tbody>
</table>

## [](#enabling-alerts)API アラートの一時停止と編集

アラートを一時停止すると、アラートは ​**\[Paused (一時停止)\]**​ に移行します。

既存のアラートは、次の手順で編集できます。

1. API Manager の左側のナビゲーションバーで、​**\[API Administration (API 管理)\]**​ をクリックします。
2. API インスタンス、および編集するバージョンをクリックし、​**\[Alerts (アラート)\]**​ をクリックします。
3. 編集したいアラートの 3 つのドットのアイコン (​![5%](/mulesoft/current/ja-jp/gateway/1.9/_images/three-dots-menu.png)​) をクリックして、​**\[Edit (編集)\]**​ を選択します。
    
    ![アラートの名前、基づいているメトリクス、重大度、状態、アラートが有効化されているかどうかを示すテーブル](/mulesoft/current/ja-jp/gateway/1.9/_images/flex-alerts-edit.png)

## [](#アラートの表示と削除)アラートの表示と削除

アラートを表示および削除する手順は、次のとおりです。

1. API Manager から、​**\[API Administration (API 管理)\] で API インスタンス**​をクリックし、​**\[Alerts (アラート)\]**​ を選択します。
    
    ![「Test fail alert (テスト失敗アラート)」という名前の展開されたアラートが表示されている API サービスコントラクトアラートのテーブル](/mulesoft/current/ja-jp/gateway/1.9/_images/view-add-alert.png)
2. リスト内のアラートを展開します。
    
    アラートのオプションに関する詳細が表示されます。
3. 削除するアラートの 3 つのドットメニュー (​![メニューとして縦に並べられた 3 つのドット](/mulesoft/current/ja-jp/gateway/1.9/_images/three-dots-menu.png)​) から ​**\[Delete (削除)\]**​ をクリックします。アラートの編集中に削除することもできます。