1. Homepage
  2. API Manager (2.x)
  3. API グループの管理

  4. API グループの変更

API グループの変更

ビジネス要件が変更された場合、新しい API インスタンスを追加して API グループを変更することをお勧めします。新しいシナリオに対応するため、新しい API インスタンスを追加すると役立ちます。

既存のインスタンスをバージョン管理して、カスタマイズを追加することもできます。サービスが不要になった場合は、そのサービスをサポートするそれぞれの API インスタンスを削除できます。ただし、API グループと API グループインスタンスの変更には特定の​制限​があります。

Exchange で API グループをパブリッシュすると、API グループの​状況​は特定のシナリオに基づいて変更されます。

API グループとインスタンスの変更に関する制限

API グループを変更する前に、制限を慎重に確認してください。

  • API グループインスタンスにコントラクトがない場合にのみ、グループにすでに存在する API の新しいインスタンスを追加する。

  • 同じ ID プロバイダー (IdP) に属する API インスタンスのみを追加する。

    API グループインスタンスに IdP を混在させることはできません。

  • 以下に該当する場合、API ではなく API インスタンスを追加する。

    • API グループインスタンスがパブリッシュされている。

    • API グループバージョンがパブリッシュされている。

    • API グループバージョンに複数の API グループインスタンスがある。

API グループトランザクションに基づく Exchange 状況

API グループの Exchange 状況は、次の条件によって異なります。

  • API グループが Exchange でパブリッシュされている場合、Exchange アセットに新しい API インスタンスが表示される。

  • 追加した API インスタンスが Exchange API グループアセットにすでにリンク済みのアセットに関連している場合、API インスタンスにこれらの詳細が表示される。

  • 追加した API インスタンスが Exchange API グループアセットにまだリンクされていない新しいアセットに属する場合、顧客が API グループアセットの新しいバージョンを作成する必要がある。

タスクの前提条件

開始する前に、以下が必要です。

  • 組織またはビジネスグループ内に少なくとも 1 つの API インスタンス

    それがない場合、リスト内で必要な組織またはビジネスグループを見つけることができません。

  • API インスタンスを API グループに追加するための「API Group Administrator (API グループ管理者権限)」

既存の API グループへの API インスタンスの追加

API インスタンスを既存の API グループに追加し、それによって解決されるビジネス上の問題の幅を広げることができます。

既存の API グループに API インスタンスを追加する手順は、次のとおりです。

  1. [Anypoint Platform]​ > ​[API Manager]​ に移動します。

  2. [API Groups (API グループ)]​ をクリックします。

  3. API グループの詳細ページで API グループを展開して、使用可能なバージョンを表示します。

  4. API インスタンスを追加する API グループのバージョンに対して ​[Add Instance (インスタンスを追加)]​ をクリックします。

    [Creating a new group instance (新規グループインスタンスの作成)]​ ページが表示されます。

  5. [+ Add (+ 追加)]​ をクリックします。

  6. API インスタンスと API グループが同じビジネスグループまたは組織に属している場合、API グループに追加する API、API バージョン、環境、API バージョン/インスタンスを選択します。

  7. API インスタンスと API グループが異なるビジネスグループに属している場合:

    1. [Add Organization (組織を追加)]​ をクリックします。

    2. API インスタンスを使用できる組織またはビジネスグループを選択し、​[Add (追加)]​ をクリックします。

    3. 追加する環境、API インスタンス、およびバージョンを選択します。

  8. [Save (保存)]​ をクリックします。

    これで、API インスタンスが API グループに追加されます。API グループを Exchange にパブリッシュするには、​「Exchange への API グループのパブリッシュ」​を参照してください。

API グループからの API インスタンスの削除

ビジネス要件が変更された場合、既存の API インスタンスを削除して API グループを変更することをお勧めします。

API グループから API インスタンスを削除する手順は、次のとおりです。

  1. [Anypoint Platform]​ > ​[API Manager]​ に移動します。

  2. [API Groups (API グループ)]​ をクリックします。

  3. API グループのページで API グループを展開して、使用可能なバージョンを表示します。

  4. API グループバージョンを展開して、使用可能なインスタンスを表示します。

  5. API グループインスタンスを展開して、インスタンスの詳細を表示します。

  6. ​[Edit (編集)]​ の隣にある、その他のオプションを表示するメニューアイコン ( overflow menu icon ) をクリックしてから、​[Delete (削除)]​ をクリックします。

    削除した API インスタンスがアセットにリンクされた最後の API である場合、API グループの新しいバージョンを作成する必要がある点に注意してください。

  7. このアクションは元に戻すことができないと​理解したことに同意するためのチェックボックスをオンにしてから ​[Delete Group instance (グループインスタンスを削除)]​ をクリックします。

API グループバージョンの作成

API グループを変更して新しい API を追加したり、ビジネス要件の変更に基づいて既存の API を削除したりする場合は、API グループを適切にバージョン管理することをお勧めします。

API グループの追加バージョンを作成する手順は、次のとおりです。

  1. [Anypoint Platform]​ > ​[API Manager]​ に移動します。

  2. [API Groups (API グループ)]​ をクリックします。

  3. API グループに対して ​[Add group version (グループバージョンを追加)]​ をクリックします。

  4. [API Group Version (API グループバージョン)]​ 項目で、作成するバージョン番号 (例: v1.1​ または ​v2.0​) を指定します。

  5. [API Group instance label (API グループインスタンス表示ラベル)]​ 項目に、このグループインスタンスを一意に識別する表示ラベルを入力します。

  6. [Continue (続行)]​ をクリックします。 .

  7. API グループに API インスタンスを追加します。

    API グループには、以前のバージョンの既存のインスタンスが事前に取り込まれています。API グループに API インスタンスを追加する方法についての詳細は、​「既存のグループへの API インスタンスの追加」​を参照してください。

  8. [Save (保存)]​ をクリックします。

関連情報