API 管理では、サービスプロジェクト内の API のトラフィックシェーピングとアラートを迅速に構成できます。このトピックでは、API のトラフィックシェーピングとアラートを構成する方法について説明します。
制限
DataService Studio の高可用性（HA）モジュールが有効になっている場合、サービスのトラフィックシェーピングルールはプライマリリンクにのみ影響し、バックアップリンクには影響しません。
開発環境のAPIでは、アラート構成はサポートされていません。
APIの呼び出しパターンが同期呼び出しから非同期呼び出しに切り替えられた場合、平均呼び出し時間のアラートルールは有効になりません。アラートルールが変更されずに、呼び出しパターンが非同期呼び出しから同期呼び出しに切り替えられた場合、対応するアラートルールは引き続き有効になります。
権限の説明
スーパー管理者、プロジェクト管理者、およびO&M担当者は、APIのトラフィックシェーピングとアラートを構成できます。
トラフィックシェーピングの構成
Dataphin ホームページの上部のメニューバーで、[サービス] > [API O&M] を選択します。
左側のナビゲーションウィンドウで、[トラフィックシェーピングとアラート] をクリックします。[API O&M] ページで、目的の API を見つけ、[アクション] 列の [レート制限] をクリックします。
[APIトラフィックシェーピング構成] ダイアログボックスで、パラメーターを構成します。
パラメーター
説明
トラフィックシェーピングステータス
トラフィックシェーピングを有効または無効にします。
時間単位
トラフィックシェーピングの時間単位を選択します。ネットワークが組み込みゲートウェイとして構成されている場合、sec のみがサポートされます。
時間単位
トラフィックシェーピングの時間単位を選択します。ネットワークが Alibaba Cloud API Gateway として構成されている場合、サポートされる単位は sec、min、hour、および day です。
APIトラフィック制限
APIのトラフィック制限を入力します。たとえば、企業が購入した総トラフィックが 500 クエリ/秒 で、時間単位 として 秒 を選択した場合、APIトラフィック制限 の値は 500 以下にする必要があります。
アプリトラフィック制限
APIのダウンストリームアプリのトラフィック制限を入力します。アプリトラフィック制限 を設定するためのルールは次のとおりです。
アプリトラフィック制限 は、API下のすべてのアプリに適用されます。
アプリトラフィック制限 は、APIトラフィック制限 以下である必要があります。
APIトラフィック制限 は、アプリトラフィック制限 よりも優先順位が高くなります。たとえば、APIトラフィック制限 が 1,000 クエリ/秒 で、App1、App2、App3 のトラフィック制限がそれぞれ 500 クエリ/秒 の場合、アプリトラフィック制限の合計はAPIトラフィック制限を超えます。ただし、トラフィックの上限は依然としてAPIトラフィック制限です。
アプリトラフィック制限 が APIトラフィック制限 より大きい場合、システムはエラーメッセージを表示します。
アプリを追加
アプリを追加 をクリックして、アプリケーション と トラフィック制限 を構成します。トラフィック制限 を設定するためのルールは次のとおりです。
特定のアプリの トラフィック制限 は、APIトラフィック制限 以下である必要があります。
特定のアプリの トラフィック制限 が APIトラフィック制限 より大きい場合、システムはエラーメッセージを表示します。
[OK] をクリックして、APIのトラフィックシェーピング構成を完了します。
タイムウィンドウ内のリクエスト数が制限に達した場合、システムはキューイング、待機、またはダウングレードによって自身を保護します。
アラートの構成
[API O&M] ページで、対象のAPIの [アクション] 列の [アラート] をクリックします。
[APIアラート] ページで、APIアラート情報を構成します。
パラメーター
説明
メトリック
アラートルール用のAPI監視メトリックを選択します。メトリック には次のものが含まれます。
呼び出し回数：指定された期間内のAPI呼び出しの合計数。
エラー率：指定された期間内のAPI呼び出しエラーの合計数をAPI呼び出しの合計数で割った値。
平均呼び出し時間：このメトリックは、同期呼び出しの場合にのみサポートされます。指定された期間内のAPI呼び出しの合計時間をAPI呼び出しの合計数で割って計算されます。
時間単位
API呼び出しの時間単位を選択します。時間単位 オプションには、1分、5分、10分、30分、60分 が含まれます。
オペレーター
メトリックを しきい値 と比較するための演算子を選択します。オペレーター には、=、>=、<=、<、>、!= が含まれます。
しきい値
アラートルールをトリガーするしきい値を入力します。
通知方法
アラート通知を送信する方法を選択します。
通知受信者
アラート通知の受信者を選択します。
サイレンス期間
短期間に複数のアラートが発生した場合、サイレンス期間を設定できます。アラート通知が送信された後のサイレンス期間中は、システムは同じAPIアラートルールに対して重複する通知を送信しません。
ステータス
オン または オフ を選択します。
[OK] をクリックして、APIのアラート構成を完了します。
アプリケーションがAPIを呼び出し、実行中に監視アラートルールをトリガーすると、システムはアラートメッセージを送信するため、例外をすばやく特定して処理できます。