1. Homepage
  2. API Governance

  3. API 準拠の監視

API 準拠の監視

API のガバナンスプロファイルを設定し、結果のガバナンスデータが使用可能になったら、組織の API 仕様の準拠の成功と失敗を監視およびレポートできます。

コンソールの状況情報

コンソールで最新の状況情報を確認できます。

API Governance コンソールのスクリーンショット
1 ガバナンスプロファイル​、​ガバナンス状況​、​準拠状況​、​重大度別非準拠​の数値および視覚的な概要を確認します。
2 ガバナンスプロファイルまたは管理対象 API の概要リストの確認、絞り込み、検索を行います。
3 準拠レポートを CSV 形式でエクスポートします。
4 新しいプロファイルを追加します。
5 API の包括的なガバナンスレポートを確認します。
6 その他のオプションメニューから選択して、関連するアクションを実行します。選択したプロファイルまたは API のレポートをエクスポートしたり、プロファイルを表示、編集、削除したり、API オーナーに通知したり、Exchange で API を開いたりすることができます。
API Governance 管理者と組織のシステム管理者のみがプロファイルを作成、編集、削除できます。
ガバナンスプロファイル

ガバナンスプロファイルは、選択したガバナンスルールセットを絞り込んだ API グループに適用します。その後、API Governance はルールセットに対して API を検証し、ガバナンス準拠を判断します。

ガバナンスプロファイルの状況

API Governance コンソールでプロファイルの状況を確認できます。ガバナンスプロファイルの状況は、プロファイル内の準拠 API の割合に基づいています。

  • Normal (通常):

    API の 70% 以上が準拠しています。

  • At Risk (リスクあり):

    API の 70% 未満が準拠しています。

管理対象 API

API は、少なくとも 1 つのガバナンスプロファイルの選択条件によって識別された場合に管理されます。API が管理されている場合、その API のすべてのバージョンが 1 つの管理対象 API とみなされます。サブスクリプション制限は、組織の購入済みの容量に基づいて設定されます。UI には使用量に関する情報が表示され、サブスクリプション容量に近づいたり超えたりしたときにアラートが表示されます。

ガバナンス状況

API Governance コンソールのガバナンス状況には、管理対象 API の数、サポート対象 API 種別の API の総数、サブスクリプション制限の情報が表示されます。

API 準拠

API 準拠は、検証済み API 仕様が 1 つ以上のガバナンスルールセット内のすべての必須ルールに合格するかどうかを示します。API 仕様が複数のガバナンスプロファイルに含まれている場合、準拠するには、それらすべてのプロファイルのすべてのルールセットに合格する必要があります。

API 準拠状況

API 準拠状況は、ガバナンスプロファイルに含まれている API が適用されるすべてのガバナンスルールセットに合格するかどうかを示します。

  • Conformant (準拠):

    API は、適用されるすべてのガバナンスルールセットに合格しています。

  • Not Conformant (非準拠):

    API は、少なくとも 1 つのガバナンスルールセットで失敗しています。

  • Not Validated (未検証):

    API は、ガバナンスプロファイルに含まれていないため検証されていません。

API の各バージョンの API 準拠状況は異なる可能性があります。API Governance コンソールにはバージョンの準拠状況の総数が表示され、API Governance、Exchange、API Manager には API バージョンの準拠状況インジケーターが表示されます。

API 準拠は、REST API や AsyncAPI など、API Governance によってサポートされる API 種別のみに適用されます。
準拠の重大度

準拠の重大度は、すべての必須ルールセットの中で合格したルールセットの割合によって分類されます。

  • High Severity (重大度高):

    0 ～ 40% のルールセットに合格

  • Medium Severity (重大度中):

    41% ～ 80% のルールセットに合格

  • Low Severity (重大度低):

    81% ～ 99% のルールセットに合格

API Governance 使用状況レポート

使用状況レポートを参照して、API Governance の月間使用量に関するインサイトを獲得できます。​「API Governance の使用状況レポートの参照」​を参照してください。

ガバナンス準拠レポート

API Governance コンソールと API Manager のガバナンス検証レポートで、管理対象 API の準拠の詳細を表示できます。準拠の問題の検出と修正を参照してください。

準拠情報をエクスポートする

API Governance コンソールのさまざまな場所から準拠情報を CSV 形式でエクスポートできます。

ガバナンスプロファイルのエクスポート

API Governance コンソールのメインページで、​[Profiles (プロファイル)]​ タブを選択し、​[Export Report (レポートのエクスポート)]​ ボタンをクリックして、次のようなガバナンスプロファイル情報をエクスポートします。

  • Organization ID (組織 ID)

  • Profile IDs (プロファイル ID)

  • Profile name (プロファイル名)

  • Status (状況)

  • Total APIs validated (検証済み API 総数)

  • Number of conformant APIs (pass) (準拠 API (合格) の数)

  • Number of nonconformant APIs (fail) (非準拠 API (失敗) の数)

  • Timestamps (タイムスタンプ)

  • Associated ruleset tags (関連ルールセットタグ)

管理対象 API のエクスポート

API Governance コンソールのメインページで、​[Governed APIs (管理対象 API)]​ タブを選択し、​[Export Report (レポートのエクスポート)]​ をクリックして、次のような管理対象 API 情報のレポートをエクスポートします。

  • Organization ID (組織 ID)

  • API IDs (API ID)

  • Versions (バージョン)

  • Total number of APIs (API の総数)

  • Number of conformant APIs (pass) (準拠 API (合格) の数)

  • Number of nonconformant APIs (fail) (非準拠 API (失敗) の数)

  • Timestamps (タイムスタンプ)

特定のプロファイルのエクスポート

選択したガバナンスプロファイルページで、その他のオプションメニューアイコン (​overflow menu icon​) をクリックし、​[Export Reports (レポートのエクスポート)]​ を選択して、次のような選択したガバナンスプロファイルの情報を表示するレポートをエクスポートします。

  • Organization ID (組織 ID)

  • API IDs (API ID)

  • Versions (バージョン)

  • Total number of APIs (API の総数)

  • Number of conformant APIs (pass) (準拠 API (合格) の数)

  • Number of nonconformant APIs (fail) (非準拠 API (失敗) の数)

  • Timestamps (タイムスタンプ)

CLI を使用した API 準拠の評価

コマンドを使用して API プロジェクトの潜在的なルールセットを評価するには、​governance:api:evaluate​ コマンドを使用します。

API Governance へのアクセス権のない開発者などのユーザーは、CLI を使用して、指定した検索条件に基づいて API の検証の対象となる可能性のあるルールセットを評価できます。これにより、開発者は API が管理対象になる前にルールセットへの API の潜在的な準拠を前もって把握できます。

また、API Governance へのアクセス権のないガバナンスオフィサーなどのユーザーは、このコマンドを使用してプロファイル設定を計画またはデバッグできます。

governance:api:evaluate

> governance:api:evaluate [フラグ]

このコマンドは、指定された検索条件を評価して、その条件を満たす API に適用されるルールセットを決定します。

このコマンドでは、デフォルトのフラグ以外に次のフラグも受け入れます。

フラグ 説明

--api=<api>

評価する API プロジェクト。このコマンドは、プロジェクトの ​exchange.json​ ファイルの条件を使用します。

--criteria <filtertype:filtervalue>,…​

ルールセットを識別するために評価する検索条件を適用できます。カンマ区切りの検索条件のリストを指定します。各検索条件の種別と値は、​filtertype:filtervalue​ の形式です。

次のような検索条件を使用できます。

  • scope​: API 種別、​rest-api​ または ​async-api​

  • tag​: Exchange で API に対して定義されたタグ

  • category​: Exchange で API に対して定義されたカテゴリ。検索条件値は ​categoryName:value​ として 2 つの部分で指定されます。

  • env-type​: 環境種別 (すべて、本番、または Sandbox)

  • env-id​: API Manager の環境名の ID。​[API Manager]​ > ​[Environment information (環境情報)]​ を使用してこの値を取得できます。​「環境の概念の確認」​を参照してください。

    env-type​ または ​env-id​ が使用されている場合、プロファイルに ​[API Instance (API インスタンス)]​ 検索条件が設定されるため、インスタンスが設定された API のみが絞り込まれます。

    CLI を使用してプロファイルの ​[API Instance (API インスタンス)]​ を選択解除するには、​env-type​ も ​env-id​ も含まれない ​--criteria​ フラグを使用してプロファイルを更新します。

例: tag:tag1,category:category1:value,category:category2:value2,scope:rest-api,scope:async-api,env-type:production
このコマンドは、​--criteria​ または ​--api​ フラグを使用して実行する必要があります。

コマンド例:

anypoint-cli-v4 governance:api:evaluate --criteria "tag:best,category:API Type:Experience API,scope:rest-api"

anypoint-cli-v4 governance:api:evaluate --api order-api-1.0.0-raml.zip
ここで、​order-api-1.0.0-raml.zip​ には API とその ​exchange.json​ ファイルが含まれています。

出力例:

╔════════════════════════════════════════════════════════════════════╗
║ Ruleset GAV                                                        ║
╟────────────────────────────────────────────────────────────────────╢
║ 68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-best-practices/1.5.1 ║
╟────────────────────────────────────────────────────────────────────╢
║ 68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-best-practices/1.0.1 ║
╚════════════════════════════════════════════════════════════════════╝

関連情報