API インスタンスの管理

API インスタンスは、API 定義のインスタンス化です。ゲートウェイとコントロールプレーン間でデータを共有するために使用されるオブジェクトです。API インスタンスは、アップストリーム用の API のプロキシ、または Mule アプリケーションエンドポイントのいずれかです。

API Manager を使用して、API インスタンスを作成、インポート、非推奨化できます。API のインスタンスは複数の環境で使用できます。同じ環境で API の複数のインスタンスを使用することもできます。

プロキシとして機能する API バージョンのインスタンスと、エンドポイントとして直接管理する API インスタンスを作成できます。API がどのように (プロキシまたはエンドポイントのどちらとして) 設定されているかに基づいて API にポリシーを適用することができます。たとえば、キャッシュポリシーをプロキシに適用でき、スロットルポリシーやセキュリティポリシーをエンドポイントに適用できます。また、API を別の環境に昇格することもできます。

API Manager で API インスタンスを管理する手順は、次のとおりです。

関連ゲートウェイの API インスタンスを追加します。
API インスタンスの [API Summary (API の概要)] を表示し、インスタンスに関する情報を得たり、インスタンスをエクスポートしたりします。
- 『Obtain API Instance ID (API インスタンス ID を取得)』 - API Manager は、Mule 4 で使用する新しい API の apiId を生成して管理します。
- 『Export an API Instance (API インスタンスをエクスポート)』 - API インスタンスを作成したらエクスポートできます。この場合、API インスタンスのエンドポイント設定と Exchange のアセットリレーションがエクスポートされます。その後、同じビジネスグループの別の環境にインポートして、新しい API インスタンスを作成できます。
- 『Access the Developer Portal (開発者ポータルへのアクセス)』 - システム管理者は API のリソースとメソッドを表示し、Anypoint Exchange (Exchange) からの他の詳細 (パブリッシュ日、モッキングサービスなど) にアクセスできます。API はアセットポータル (非公開) または公開ポータルで表示できます。
インスタンスが不要になった場合、または更新する必要がある場合は、API インスタンスを変更します。
- 『Edit an API Instance (API インスタンスを編集)』 - API インスタンスの設定を編集して、ベースパス、ポート、TLS コンテキストなどを更新します。
- 『Deprecate an API Instance (API インスタンスの非推奨化)』 - API のコンシューマーを更新されたインスタンスに移行する間、開発者が古い API インスタンスにアクセスするためのサインアップを行わないようにすることができます。
- 『Delete an API Instance (API インスタンスを削除)』 - API インスタンスを API Manager から管理する必要がなくなった場合、API インスタンスとそのバージョンを削除できます。
- 『Manage API Versions (API バージョンの管理)』 - Anypoint Platform で API を作成した後に、API のバージョンの詳細を設定し、それを Anypoint Exchange (Exchange) にパブリッシュします。API バージョンは API Manager ではなく Exchange で管理されます。ただし、この API バージョンの管理は API Manager で行います。
API インスタンスの高度なユースケースを調べます。
- 『Configure Multiple Client Providers (複数のクライアントプロバイダーを設定)』 - OpenAM や PingFederate など、複数のクライアントプロバイダーを使用して、ビジネス組織のセキュリティや規制を適用しやすくすることができます。これらのクライアントプロバイダーを使用することで、クライアントのログイン情報やアクセストークンなどの運営データを保護できます。
- 『Govern API Instances (API インスタンスを管理)』 - Anypoint API Governance を使用して API インスタンスを管理できます。管理対象インスタンスのガバナンス検証レポートを表示して、準拠の問題を特定し、修正するためのアクションを実行します。