API Hub をプロビジョニングする

このページは Apigee と Apigee ハイブリッドに適用されます。

このトピックでは、Google Cloud コンソールの Apigee UI を使用して API Hub をプロビジョニングする方法について説明します。これは、API Hub のプロビジョニングに推奨される方法です。図 1 は、このプロビジョニング ドキュメントで説明する基本的な手順を示しています。

API Hub のプロビジョニング手順
図 1.Apigee API Hub インスタンスをプロビジョニングする手順。

始める前に

  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Make sure that billing is enabled for your Google Cloud project.

  4. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  5. Make sure that billing is enabled for your Google Cloud project.

  6. Make sure that you have the following role or roles on the project:

    • roles/serviceusage.serviceUsageAdmin
    • roles/cloudkms.admin
    • roles/apihub.provisioningAdmin
    • roles/resourcemanager.projectIamAdmin

    Check for the roles

    1. In the Google Cloud console, go to the IAM page.

      Go to IAM
    2. Select the project.

    3. In the Principal column, find all rows that identify you or a group that you're included in. To learn which groups you're included in, contact your administrator.

    4. For all rows that specify or include you, check the Role colunn to see whether the list of roles includes the required roles.

    Grant the roles

    1. In the Google Cloud console, go to the IAM page.

      [IAM] に移動
    2. プロジェクトを選択します。
    3. [ アクセスを許可] をクリックします。

    4. [新しいプリンシパル] フィールドに、ユーザー ID を入力します。 これは通常、Google アカウントのメールアドレスです。

    5. [ロールを選択] リストでロールを選択します。
    6. 追加のロールを付与するには、 [別のロールを追加] をクリックして各ロールを追加します。
    7. [保存] をクリックします。

    ステップの概要

    プロビジョニングの手順は次のとおりです。

    1. ステップ 1: API を有効にする。Apigee では、いくつかの Google Cloud API を有効にしておく必要があります。
    2. ステップ 2: ホスティング ロケーションを選択する。API Hub の物理的な場所を指定します。
    3. ステップ 3: ホスト プロジェクトを登録する。デフォルトでは、現在の Google Cloud プロジェクトが選択されています。
    4. 手順 4. 暗号化を構成します。顧客管理の暗号鍵（CMEK）を選択または作成するか、Google が管理する暗号鍵（GMEK）を使用して、保存中の API データを暗号化および復号します。
    5. ステップ 5: サービス ID を作成する。サービス ID にアクセス権限を割り当てます。
    6. API Hub インスタンスを作成します。プロビジョニングが完了するまで数分かかります。

    プロビジョニングのステップ

    API Hub のプロビジョニングを開始するには:

    1. 始める前にに記載されている前提条件を満たしていることを確認します。

    2. Google Cloud コンソールで、Apigee API Hub のウェルカム ページに移動します。

      [Apigee API Hub] に移動

    3. [インスタンスを作成] をクリックします。
      • 組織で API Hub がプロビジョニングされていない場合、UI にはプロビジョニング ワークフローのステップ 1 が表示されます。
      • API Hub がすでにプロビジョニングされている場合は、API リソース ページに移動します。

    ステップ 1: API

    API Hub をプロビジョニングするには、Google Cloud プロジェクトで次の API を有効にする必要があります。

    API 名 場所 説明
    API Hub API apihub.googleapis.com API Hub API。
    Cloud Key Management Service（KMS） cloudkms.googleapis.com

    鍵を管理し、他の Cloud リソースで直接使用できるように暗号オペレーションを実行します。

    必要な API を有効にするには、[API の有効化] をクリックします。この手順が完了するまでに数秒かかります。

    ステップ 2: 位置情報

    2 つのロケーションを選択する必要があります。1 つは、Apigee API Hub インスタンスをホストする物理的なロケーション（リージョン）で、もう 1 つは Vertex AI 検索データが保存されるマルチリージョンです。

    1. プルダウン リストから、API Hub インスタンスをホストするリージョンを選択します。サポートされているロケーションは次のとおりです。
      リージョンの説明 リージョン名
      アイオワ us-central1
      北バージニア us-east4
      オレゴン us-west1
      ベルギー europe-west1
      ロンドン europe-west2
      シンガポール asia-southeast1
      ムンバイ asia-south1
      サンパウロ southamerica-east1
      シドニー australia-southeast1

    2. [Vertex 検索機能を有効にする] オプションが有効になっている場合（デフォルト）、Vertex AI ベースの検索データ（API Hub のセマンティック検索機能に関連付けられたデータ）を保存するマルチリージョン ロケーションを選択する必要があります。デフォルトでは、手順 1 で設定した API Hub リージョンを含むマルチリージョンが選択されています。たとえば、API Hub リージョンとして us-central1 を選択すると、デフォルトでマルチリージョン us が選択されます。ただし、必要に応じて別のマルチリージョンに変更できます。

      Vertex 検索オプションを使用すると、Vertex AI を活用した API Hub のセマンティック検索機能を有効にできます。[Vertex 検索機能を有効にする] オプションの選択を解除すると、セマンティック検索が無効になり、マルチリージョン セレクタは非表示になります。

    3. [Set location] をクリックします。

    ステップ 3: ホスト プロジェクトを登録する

    ホスト プロジェクトは、Apigee 組織内の Google Cloud プロジェクトであり、すべての API Hub リソースのコンシューマ プロジェクトとして指定します。ホスト プロジェクトごとに 1 つの API Hub インスタンスをプロビジョニングできます。

    Apigee 組織の Google Cloud プロジェクトを API Hub のホスト プロジェクトとして使用するには、[登録] をクリックします。

    ステップ 4: 暗号化

    この手順では、Google 管理の暗号鍵（GMEK）または Cloud Key Management Service で定義された顧客管理の暗号鍵（CMEK）を使用して、API Hub インスタンスに保存されているデータを暗号化できます。

    Google が管理する暗号鍵を使用するには、[Google が管理する暗号鍵] オプションを選択します。このオプションを選択した場合、これ以上の鍵の構成は必要ありません。

    既存の CMEK を使用するには:

    1. [顧客管理の暗号鍵（CMEK）を選択] ボックスに入力してフィルタするか、スクロールして既存の鍵を検索します。または、鍵のリソース ID を入力して既存の鍵を探すこともできます。
    2. キーを選択して [OK] をクリックします。
    3. [確認] をクリックします。

    新しい CMEK を作成するには:

    1. [鍵を作成] をクリックします。[Create a new key] ダイアログが表示されます。
    2. [キーリング] セクションで、既存のキーリングを指定するか、新しいキーリングを作成します。
      • 既存のキーリングを使用するには:
        1. [キーリング] リストから既存のキーリングを選択します。
        2. [続行] をクリックします。
      • 新しいキーリングを作成するには:
        1. [キーリングを作成] 切り替えボタンをクリックするか、選択ボックスで [キーリングを作成] をクリックします。
        2. [キーリング名] フィールドに、キーリングの名前を入力します。

          キーリングの名前には、英数字、アンダースコア（_）、ハイフン（-）を使用できます。キーリングの名前の変更や削除はできません。

        3. [キーリングのロケーション] リストからロケーションを選択します。

          前のステップで選択したのと同じホスティング ロケーションを指定して、キーとデータが同じリージョンに保管されるようにする必要があります。

        4. [続行] をクリックします。
    3. [キー] セクションで次の操作を行います。
      1. [鍵名] フィールドに鍵の名前を入力します。

        鍵名には、英数字、アンダースコア（_）、ハイフン（-）を使用できます。鍵の名前変更や削除はできません。

      2. [保護レベル] で、[Software] などを選択します。
      3. [続行] をクリックします。
    4. [確認] セクションで、鍵の作成に指定した詳細を確認します。

      情報が正しい場合は、[作成] をクリックします。

    5. [顧客管理の暗号鍵を選択します] ボックスで、新しく作成した鍵を選択します。
    6. [暗号鍵を確定] をクリックします。

    ステップ 5: サービス ID

    このステップでは、新しいサービス ID を作成し、選択した顧客管理の暗号鍵へのアクセス権を付与します。この鍵は、API Hub データの暗号化と復号に使用されます。

    新しいサービス ID を作成するには、[サービス ID を作成して権限を付与する] をクリックします。

    Apigee はサービス アカウントを作成し、cloudkms.cryptoKeyEncrypterDecrypter、apihub.admin、apihub.runtimeProjectServiceAgent のロールをサービス アカウントに割り当てます。

    API Hub インスタンスを作成する

    [送信] をクリックして、API Hub インスタンスを作成します。

    プロビジョニングが開始されると、[API Hub インスタンスの最終処理] ページが表示されます。この手順が完了するまでに数分かかることがあります。

    プロビジョニングが完了すると、API ハブの [API] ページが表示されます。

    次のステップ

    これで完了です。API Hub が正常にプロビジョニングされました。

    これで、API Hub の使用を開始できます。