Apigee API Hub
Apigee API Hub コネクタを使用すると、組織のポートフォリオ内の API を管理、検出、制御できます。
サポート対象のバージョン
このコネクタは、Apigee API Hub バージョン v1 をサポートしています。
始める前に
-
Google Cloud プロジェクトで次のタスクを行います。
- ネットワーク接続が設定されていることを確認します。ネットワーク パターンの詳細については、Network Connectivity をご覧ください。
- コネクタを構成するユーザーに roles/connectors.admin IAM ロールを付与します。
- 次のサービスを有効にします。
secretmanager.googleapis.com（Secret Manager API）connectors.googleapis.com（Connectors API）
サービスを有効にする方法については、サービスを有効にするをご覧ください。以前にプロジェクトでこうしたサービスを有効にしていない場合は、コネクタを構成するときに有効にするよう求められます。
- OAuth 2.0 認証の代わりにサービス アカウント認証を使用している場合は、サービス アカウントに適切な権限が付与されていることを確認してください。詳細については、事前定義された IAM ロールをご覧ください。
Apigee API Hub 接続を作成する
接続はデータソースに特有です。つまり、多数のデータソースがある場合は、データソースごとに別々の接続を作成する必要があります。接続を作成する手順は次のとおりです。
- Cloud コンソールで、[Integration Connectors] > [接続] ページに移動し、Google Cloud プロジェクトを選択または作成します。
- [+ 新規作成] をクリックして [接続の作成] ページを開きます。
- [ロケーション] セクションで、[リージョン] リストからロケーションを選択し、[次へ] をクリックします。
サポートされているすべてのリージョンのリストについては、ロケーションをご覧ください。
- [接続の詳細] セクションで、次の操作を行います。
- [Connector] リストから [Apigee API hub] を選択します。
- [コネクタのバージョン] リストからコネクタのバージョンを選択します。
- [接続名] フィールドに、接続インスタンスの名前を入力します。接続名には、小文字、数字、ハイフンを使用できます。名前の先頭は英字、末尾は英字または数字にする必要があります。名前は 49 文字以下にする必要があります。
- 必要に応じて、接続インスタンスの [説明] を入力します。
- 必要に応じて、Cloud Logging を有効にして、ログレベルを選択します。デフォルトのログレベルは
Errorに設定されています。 - サービス アカウント: 必要なロールを持つサービス アカウントを選択します。
- （省略可）接続ノードの設定を構成します。
- ノードの最小数: 接続ノードの最小数を入力します。
- ノードの最大数: 接続ノードの最大数を入力します。
- [次へ] をクリックします。
ノードは、トランザクションを処理する接続の単位（またはレプリカ）です。1 つの接続でより多くのトランザクションを処理するには、より多くのノードが必要になります。逆に、より少ないトランザクションを処理するには、より少ないノードが必要になります。ノードがコネクタの料金に与える影響については、 接続ノードの料金をご覧ください。値を入力しない場合は、デフォルトで最小ノード数は 2 に設定され（可用性を高めるため）、最大ノード数は 50 に設定されます。
- [宛先] セクションに、接続するリモートホスト（バックエンド システム）の詳細を入力します。
- [宛先の種類] フィールドで、宛先を選択します。
- [ホストアドレス] フィールドに、宛先のホスト名または IP アドレスを指定します。
（省略可）他の宛先を入力するには、[+ 宛先を追加] をクリックします。
- [次へ] をクリックします。
-
[認証] セクションで、認証の詳細を入力します。
- [認証タイプ] を選択し、関連する詳細を入力します。
Apigee API Hub 接続でサポートされる認証タイプは次のとおりです。
- OAuth 2.0 - 認証コード
- サービス アカウント認証
- [次へ] をクリックします。
これらの認証タイプの構成方法については、認証を構成するをご覧ください。
- [認証タイプ] を選択し、関連する詳細を入力します。
- 接続と認証の詳細を確認し、[作成] をクリックします。
認証を構成する
使用する認証に基づいて詳細を入力します。
- OAuth 2.0 - 認証コード: ウェブベースのユーザー ログインフローを使用して認証する場合は、このオプションを選択します。次の詳細を指定します。
- クライアント ID: バックエンド Apigee API Hub サービスに接続するために必要なクライアント ID。
- スコープ: 必要なスコープのカンマ区切りのリスト。必要な Google サービスでサポートされている OAuth 2.0 スコープを確認するには、Google API の OAuth 2.0 スコープ ページの関連セクションをご覧ください。
- クライアント シークレット: Secret Manager のシークレットを選択します。この認証を構成する前に、Secret Manager のシークレットを作成しておく必要があります。
- シークレットのバージョン: クライアント シークレットの Secret Manager シークレットのバージョン。
-
サービス アカウント認証: この接続を構成するときに前の手順で指定したサービス アカウントを使用して認証するには、このオプションを選択します。サービス アカウントに、認証に必要な適切な IAM ロールと権限が付与されていることを確認してください。
- Scopes: プルダウンから必要な OAuth 2.0 スコープを選択します。詳細については、アクセス スコープをご覧ください。
Authorization code 認証タイプの場合は、接続を作成した後、接続を承認する必要があります。
接続を承認する
OAuth 2.0 - 認証コードを使用して接続を認証する場合は、接続の作成後に次のタスクを完了します。
- 接続ページで、新しく作成された接続を見つけます。
新しいコネクタの [ステータス] は [承認が必要] になります。
- [承認が必要] をクリックします。
これにより、[承認の編集] ペインが表示されます。
- [リダイレクト URI] の値を外部アプリケーションにコピーします。
- 認可の詳細を確認します。
- [Authorize（承認）] をクリックします。
認可が成功すると、[接続] ページの接続ステータスが「有効」に設定されます。
認証コードの再認可
Authorization code 認証タイプを使用していて、Apigee API Hub の構成を変更した場合は、Apigee API Hub 接続を再認可する必要があります。接続を再認可するには、次の手順を行います。
システムの上限
Apigee API Hub コネクタは、ノードごとに 1 秒あたり最大 20 件のトランザクションを処理でき、この上限を超えるトランザクションをスロットルします。デフォルトでは、Integration Connectors は、接続に 2 つのノードを割り当てます（可用性を高めるため）。
Integration Connectors に適用される上限の詳細については、上限をご覧ください。
統合で Apigee API Hub 接続を使用する
接続を作成すると、Application Integration で使用できるようになります。この接続は、コネクタタスクを介して統合で使用できます。
操作
接続されたバックエンド サービスのオブジェクトを抽象化するレイヤを提供します。バックエンドのオブジェクトには、この抽象化を通じてのみアクセスできます。抽象化はアクションとして公開されます。Action は、コネクタ インターフェースを介して統合で使用できる最初のクラス関数です。アクションを使用すると、1 つまたは複数のエンティティに対して変更を加えることができます。また、使用できるアクションはコネクタごとに異なります。ただし、コネクタがどのアクションもサポートしていない可能性があります。その場合は、Actions リストが空になります。
既知の問題
Apigee API Hub コネクタには構成制限があります。検索可能なリソースは 2.5 MB に制限され、API 仕様ファイルは 10 MB に制限されます。詳細については、Apigee API Hub の上限をご覧ください。
Google Cloud コミュニティの助けを借りる
Google Cloud コミュニティの Cloud フォーラムで質問を投稿したり、このコネクタについてディスカッションしたりできます。
次のステップ
- 接続を一時停止して再開する方法を確認する。
- コネクタの使用状況をモニタリングする方法を確認する。
- コネクタログを表示する方法を確認する。