API Gateway:APIのアラートの設定

1. リソースの関連付け

API Gatewayのモニタリングおよびアラート機能は、さまざまなビジネス要件を満たすことができます。 API Gatewayは、次のモニタリングメトリックをサポートしています。

• HttpStatusCode

• APIの応答時間

• APIに対するリクエストの総数

• インバウンドトラフィック

• アウトバウンドトラフィック

次のいずれかの方法を使用して、アラートルールを作成し、アラートルールを1つ以上のAPIに関連付けることができます。

• アラートルールを、同じリージョンにある単一のAPIまたは複数のAPIに関連付けます。 この方法は、単一のAPIにアラートルールを設定するシナリオ、または同じリージョンにある複数のAPIに同じアラートルールを設定するシナリオに適用できます。 API設定が変更されても、アラートルールは影響を受けません。

• アラートルールをAPIグループに関連付けます。 この方法は、APIグループ内のすべてのAPIに同じアラートルールを設定して、APIの呼び出しを監視するシナリオに適用できます。 APIグループ内のAPIを追加、削除、または変更すると、システムはAPIグループとアラートルールの間で変更を同期します。

• アラートルールをAlibaba Cloudアカウントに属するすべてのAPI Gateway APIに関連付けます。 この方法は、少数のAPIのみを管理するシナリオに適用できます。

2. アラートレベルと方法の設定

CloudMonitorでは、次のタイプのアラートレベルを設定できます: クリティカル、警告、および情報。 CloudMonitorがアラート通知の送信に使用する方法は、アラートレベルによって異なります。 アラート通知の詳細については、「概要」をご参照ください。

• 重要: システムは、電話、テキストメッセージ、電子メール、およびDingTalkチャットボットでアラート通知を送信します。 DingTalkチャットボットは、料金を支払った後にのみ使用できます。

• 警告: システムは、テキストメッセージ、電子メール、およびDingTalkチャットボットでアラート通知を送信します。

• 情報: システムは電子メールとDingTalkチャットボットでアラート通知を送信します。

3. アラートルールを1つ以上のAPIに関連付ける

アラートルールを1つ以上のAPIに関連付ける場合、アラートテンプレート、アラートルール、アラート連絡先、およびアラート通知を設定できます。 詳細については、「概要」をご参照ください。

1 API Gatewayコンソールにログインします。 上部のナビゲーションバーで、管理するAPIが存在するリージョンを選択します。 左側のナビゲーションウィンドウで、[APIの管理] > [API] を選択します。

2. [API] ページで、管理するAPIの名前をクリックして、APIの詳細ページに移動します。 左側のナビゲーションツリーで、[モニタリング] をクリックします。 表示されるページで、右上隅にある [アラートルールの作成] をクリックして、[CloudMonitorコンソールのアラートルールページ] に移動します。

3. [アラートルール] ページで、[アラートルールの作成] をクリックします。 [アラートルールの作成] パネルで、[プロダクト] ドロップダウンリストから [API Gateway] を選択し、[リソース範囲] パラメーターとして [インスタンス] を選択し、[インスタンスの追加] をクリックします。 [インスタンスの追加] ダイアログボックスで、追加するAPIを選択します。

4. アラートルールをAPIグループに関連付ける

1. APIグループ内のすべてのAPIに同じアラートルールを適用するには、次の操作を実行します。左側のナビゲーションウィンドウで、[APIの管理]> [APIグループ] を選択します。 [APIグループ] ページで、管理するAPIグループをクリックします。 グループの詳細ページの右上隅にある [CloudMonitorの有効化] をクリックします。

2. APIグループに対して初めてCloudMonitorを有効化すると、API Gatewayのサービスにリンクされたロールを作成するように促すダイアログボックスが表示されます。 詳細については、「AliyunServiceRoleForApiGatewayMonitoringサービスにリンクされたロール」をご参照ください。

3. [確認] をクリックします。 選択したAPIグループに対してCloudMonitorがアクティブ化されたことを通知するメッセージが表示されます。 メッセージには、CloudMonitorアプリケーショングループの名前が含まれています。 アプリケーショングループは、API Gatewayに関連する権限を付与した後、CloudMonitorコンソールのAPI Gatewayによって作成されます。 アプリケーショングループは、現在のAPIグループに対応しています。 アプリケーショングループの名前は、APIGATEWAY _${ region }_${ groupId} の形式です。 ${region} パラメーターは、APIグループが存在するリージョンを示します。 ${groupId} パラメーターは、APIグループのIDを示します。

4. CloudMonitorが有効化されたら、グループの詳細ページの右上隅にある [設定のためにCloudMonitorに移動] をクリックします。 表示されるページで、APIグループを [Associated Cloud Services] セクションに追加して、アプリケーショングループのアラートルールをAPIグループに適用します。

5. アラートルールをすべてのAPIに関連付ける

アラートルールをすべてのAPIに関連付けるために実行する操作は、このトピックの「セクション3」で説明した操作と同様です。 ただし、リソース範囲をすべてのリソースに設定する必要があります。 すべてのAPIにアラートルールを設定すると、Alibaba Cloudアカウント内のすべてのリージョンのAPI GatewayのすべてのAPIに同じアラートルールが有効になります。 この場合、APIに固有のアラートルールを設定することはできません。 この方法は、少数のAPIのみを管理するシナリオに適用できます。

6. API Gatewayでサポートされているアラートルール

API Gatewayは、さまざまなディメンションのAPIを監視します。 次のディメンションに基づいてアラートルールを設定できます。

• APIの応答時間: バックエンドサービスの応答時間。

• APIに対するリクエストの総数: 特定の期間内にクライアントから特定のAPIに対してAPI Gatewayが受信したリクエストの総数。

• インバウンドトラフィック: 特定の期間内にAPI Gatewayがクライアントから受信したリクエストのトラフィック。

• 送信トラフィック: 特定の期間内にAPI Gatewayからバックエンドサービスに送信されるリクエストのトラフィック。

• HTTPステータスコード: API Gatewayによって返されるステータスコード。 次のHTTPステータスコードがサポートされています。

-HTTP 2XXステータスコード: APIリクエストが受信されました。 注: 受信したリクエストは、リクエストが意図した操作が成功したことを示すものではありません。

-HTTP 4XXステータスコード: パラメーターエラーなど、クライアントでエラーが発生しました。

-HTTP 5XXステータスコード: バックエンドサービスでエラーが発生しました。 APIプロバイダーは、このようなエラーを注意深く監視する必要があります。

7. 使用上の注意

• APIが公開されている環境に基づいてアラートルールを設定できます。 VPCで公開されたAPIに対して設定されたアラートルールが有効にならない場合は、次の操作を実行することを推奨します。API Gatewayコンソールにログインし、APIを検索し、API名をクリックしてAPIの詳細ページに移動します。 左側のナビゲーションツリーで、[モニタリング] をクリックします。 [モニタリングデータ] ページで、環境ごとにAPIのモニタリングデータを照会できるかどうかを確認します。 環境ごとにモニタリングデータを照会できない場合は、チケットを起票してAPI Gatewayインスタンスのバージョンを更新してください。