Anypoint API Manager とは
Anypoint API Manager (API Manager) は、API を管理、制御、保護できる Anypoint Platform のコンポーネントです。API Manager は、ポリシーの適用、分析データの収集と追跡、プロキシの管理、暗号化と認証の提供、アプリケーションの管理を行う API ゲートウェイや Anypoint Service Mesh のランタイム機能を利用します。
API Manager は、次のツールと緊密に統合されています。
-
API の構造を指定するための Anypoint Design Center (Design Center)
-
API アセットを保存およびパブリッシュするための Anypoint Exchange (Exchange)
-
API を実装するための Anypoint Studio (Studio)
-
API (またはプロキシ) をデプロイ、管理、監視するための Anypoint Runtime Manager (Runtime Manager)
API Manager を使用する前に、ユーザインターフェースやそこで実行できるタスクに慣れておいてください。
API Manager の外観
API Manager にアクセスするには、Anypoint Platform にログインし、メインメニューから [API Manager] を選択します。
| 1 | 環境セレクタ。Anypoint Platform を使用すれば、API およびアプリケーションの個別のデプロイ環境を作成して管理できます。API Manager には、設計環境以外のすべての環境が表示されます。詳細は、「環境の切り替え」を参照してください。 |
| 2 | ナビゲーションメニュー:
|
| 3 | [Manage API (API を管理)] ボタン。Exchange から既存の API インスタンスを追加したり、RAML/OAS/SOAP 定義をアップロードしたり、API Manager からエクスポートされた設定 ZIP ファイルをインポートしたりできます。詳細は、「API 管理の入門」を参照してください。 |
| 4 | [Environment information (環境情報)] ボタンは、管理者ユーザのみが使用できます。管理者は、現在の環境に関する情報 (環境のログイン情報など) が含まれるダイアログを表示できます。環境のログイン情報を使用して、Anypoint Service Mesh アダプタをプロビジョニングしたり、環境と同期するように Studio を設定したりします。 |
| 5 | [Promote from environment (環境から昇格)] ボタンをクリックします。任意の環境から現在の環境に API を昇格できます。詳細は、「別の環境への API インスタンスの昇格」を参照してください。 |
| 6 | Search (検索)。API 検索項目を介して管理 API を検索できます。検索では大文字小文字は区別されません。[Active (アクティブ)] を選択して、検索結果を絞り込みます。 |
| 7 | 各 API の追跡登録状況 ([Active (アクティブ)]、[Inactive (非アクティブ)]、[Unregistered (未登録)])。
[Unregistered (未登録)] の状況は、Anypoint Platform がこの API バージョンのエンドポイントを一度も追跡していないことを意味します。まだプラットフォームと通信していない API またはプロキシの URL を入力したか、API ゲートウェイ以外の場所でホストされているエンドポイントを宣言していて、プラットフォームで追跡できるようにそのエンドポイントをプロキシする必要があります。 ガバナンスポリシーや SLA 層が機能するには、エンドポイントの追跡登録状況が [Active (アクティブ)] になっている必要があります。 |
| 8 | 各 API の名前。API 名をクリックすると、以下を管理する API 設定ビューに移動します。
|
| 9 | エラーが発生した API 要求の割合 (過去 24 時間)。
「No Data (データなし)」が表示されている場合、API の自動監視は有効になっていません。詳細は、Anypoint Monitoring の「はじめに」を参照してください。 |
| 10 | API 要求の合計数 (過去 24 時間)。
「No Data (データなし)」が表示されている場合、API の自動監視は有効になっていません。詳細は、Anypoint Monitoring の「はじめに」を参照してください。 |
| 11 | 各 API のコントラクトされているクライアントアプリケーションの数。詳細は、「クライアントアプリケーションとコントラクト」を参照してください。 |
API Manager のコンポーネント、概念、機能
ポリシー
ポリシーを使用すると、セキュリティの管理、トラフィックの制御、API の適応性の向上に役立つ規制を適用できます。たとえば、ポリシーは認証、アクセス、割り当てられたコンシューム量、サービスレベルアクセス (SLA) を制御できます。
API Manager では、次のポリシーの種類がサポートされます。
-
デフォルトポリシー
-
カスタムポリシー
詳細は、「ポリシー」を参照してください。
SLA 層
サービスレベルアクセス (SLA) 層は、API で定義するユーザアクセスのカテゴリです。層定義と SLA ベースのポリシーの組み合わせにより、特定のレベルの API へのアクセスで承認が必要かどうかが決まります。層定義では、アプリケーションで API に対して実行できる要求数を制限することもできます。SLA 層を適用するには、SLA ベースのレート制限または調整ポリシーを適用する必要があります。
詳細は、「SLA 層の概念の確認」を参照してください。
クライアントプロバイダ (ID プロバイダ)
クライアントプロバイダを使用してビジネス組織のセキュリティや規制を適用します。クライアントプロバイダは、クライアントアプリケーションを認証します。
クライアントプロバイダの使用についての詳細は、「クライアント管理用の複数のクライアントプロバイダの設定」を参照してください。
コントラクト
コントラクトは、クライアントアプリケーションが API をコンシュームする方法を定義します。クライアントアプリケーションは、Exchange のアクセス権を要求します。要求の承認は API インスタンスのオーナーが API Manager で行うか、自動的に行われます。これは、設定によって決まります。
コントラクトは、以下のいずれかで適用されます。
-
SLA 適用ポリシー
-
クライアント適用ポリシー
適用ポリシーについての詳細は、「クライアントアプリケーションとコントラクト」を参照してください。
API アラート
API アラート (Runtime Manager アラートとは異なる) は、次のいずれかを示すアラームです。
-
API 要求がポリシーに違反している。
-
API で受信した要求が指定された期間内の指定された数を超えている。
-
API が指定された HTTP エラーコードを返す。
-
API 応答時間が指定されたタイムアウト値を超えている。
API Manager は、状態が [desirable (望ましい)] から [undesirable (望ましくない)] (またはその逆) に変わったときにアラートをトリガします。アラートがトリガされると、API Manager はあなたまたは設定で指定した他のユーザにメール通知を送信します。
詳細は、「アラートの概念の確認」を参照してください。
API アセット
Exchange でパブリッシュされた API アセットは、アプリケーションを構成するコンポーネントです。コンポーネントには、以下のいずれかが含まれます。
-
API (OAS、RAML、RAML フラグメント、HTTP、WSDL、カスタム)
-
API グループ
-
ポリシー
-
例
-
テンプレート
-
モジュール
-
コネクタ
非公開 Exchange や Exchange 公開ポータルを介したアセットの共有についての詳細は、「アセットの共有」を参照してください。
API Console (API コンソール)
API Manager で API を作成または編集するときに、API Console を使用して API 仕様を公開およびテストします。プロキシを使用したエンドポイントとして API を管理する場合、RAML および OAS API をテストできます。Mule アプリケーション用の標準のプロキシをダウンロードしたときに、コンソールフローが API 仕様にすでに含まれ、(デフォルトで) 有効になっています。
Mule 4 以降、API Console へのアクセスを有効にして、API Manager から API Console パスを変更できます。API Manager からの API Console アクセスはデフォルトで無効になっています。API Manager からの API Console アクセスを有効にする方法については、「Exchange からのインポートによる API インスタンスの作成」を参照してください。
API グループ
API グループは、単一ユニットとして機能する API インスタンスのコレクションです。これにより、アプリケーションは 1 つのクライアント ID を使用して API インスタンスにアクセスできます。API グループは、API Manager で作成して、Exchange にパブリッシュします。
詳細は、「API グループ」を参照してください。
自動検出スキーム
API Manager は、自動検出スキームを使用し、API をそのライフサイクル (変更、バージョン管理、デプロイメント、ガバナンス、デプロイ、パブリッシュ) を通して追跡できます。
ビジネスグループ
システム管理者は組織内の個人をビジネスグループにグループ化します。各グループには独自の Exchange API アセットと環境があります。
詳細は、「ビジネスグループ」を参照してください。
環境
Anypoint Platform を使用すれば、API およびアプリケーションの個別のデプロイ環境を作成して管理できます。これらの環境は互いに独立しており、本番環境と同じ条件でアプリケーションをテストできます。
Anypoint Platform の戦略コンポーネントの環境がサポートされるようになり、バージョン名を作成して環境を反映させる必要がなくなりました。環境のアクセス制限と管理も簡略化されます。API のアクセス権限は環境に基づきます。
詳細は、「環境」を参照してください。