インスタンスの管理

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

Apigee Edge のドキュメントを表示する。

インスタンスとは、API プロジェクトと関連サービスが保存される仮想マシンのことです。インスタンスはリージョンに対応しています。通常は単一のインスタンスから始めて、組織がさらに多くのリージョンに拡張するにつれて新しいインスタンスを追加します。このセクションでは、次の方法を説明します。

新しいインスタンスを作成する

新しいインスタンスを作成するには、Instances API または Apigee UI を使用します。各インスタンスには次が必要です。

  • ネットワークの独自のディスク暗号鍵。新しいインスタンス用に別個のキーリングを作成することもおすすめします。詳細については、Apigee 暗号鍵についてをご覧ください。
  • ネットワーク ピアリングで、重複しない独自の /22 および /28 CIDR 範囲。異なるインスタンス間で範囲は共有できません。

Cloud コンソールの Apigee

Google Cloud コンソールの Apigee で新しいインスタンスを作成するには:

  1. ブラウザで Google Cloud コンソールの Apigee UI を開きます。

  2. [管理] > [インスタンス] を選択します。 [インスタンス] ペインに、既存のインスタンスのリストが表示されます。

  3. [+ 作成] をクリックします。UI が新しいインスタンスを作成するための適切な資格が組織にあるかどうかを判断するのに、時間がかかることがあります。

    [インスタンスを新規作成] ページが表示されます。

  4. フィールドに新しいインスタンスの詳細を入力します。
    フィールド 必須 説明
    Runtime hosting location 必須 新しいインスタンスを作成するリージョンを選択します。インスタンスがすであるリージョンには、新しいインスタンスを作成できません。複数のリージョンの使用について詳しくは、複数リージョンの使用をご覧ください。
    Name 必須

    新しいデプロイの ID を入力します。

    デフォルト値は選択したランタイム ホスティング リージョンの名前ですが、命名規則に従っていれば任意の名前に変更できます。

    • 最小文字数は 2 文字です。
    • 最大文字数は 32 文字です。
    • 小文字、数字、ハイフンのみを使用できます（パターン /^[a-z0-9\-]+$/ に従います）。
    • 先頭は文字でなければならず、数字またはハイフンであってはいけません。
    • 末尾は数字または文字でなければならず、ハイフンであってはいけません。
    • 組織全体で一意である必要があります。
    IP range allocation 必須

    IP 範囲の割り当て方法を指定します。次のいずれかのオプションを選択します。

    • 自動（推奨） - Apigee によって、プレフィックス サイズが /22 の使用可能な CIDR 範囲が選択されます。お客様側での対応は特に必要ありません。
    • カスタム - 高度なユースケースでは、Apigee で使用する IP 範囲を厳密に指定しなければならない場合があります。このような場合は、プレフィックス サイズが /22 のカスタム IP 範囲を指定します。範囲は、プロジェクトと Apigee 間のプライベート接続の一部として使用できる必要があります。
    Disk encryption key 必須

    [Disk encryption key] で、顧客管理の暗号鍵を選択します。鍵がすでに存在する場合は、それを選択できます。ウィザードには、すべてのキーリングでランタイムをホストしているリージョンと同じ場所にあるすべての鍵が一覧表示されます。鍵が存在しない場合や、既存の鍵を使用しない場合は、ウィザード内から新しい鍵を作成できます。鍵を作成するには:

    1. [鍵を作成] をクリックします。
    2. キーリングを選択するか、存在しない場合は [キーリングを作成] を有効にしてキーリングの名前を入力し、キーリングのロケーションを選択します。キーリングの名前には、英数字、アンダースコア（_）、ハイフン（-）を使用できます。キーリングの名前の変更や削除はできません。
    3. [続行] をクリックします。
    4. 鍵を作成します。名前と保護レベルを入力します。鍵の名前には文字、数字、アンダースコア（_）、ハイフン（-）を使用できます。鍵の名前の変更や削除はできません。保護レベルについては、Software が適しています。これは Cloud KMS で使用されているデフォルトと同じです。ただし、必要に応じて変更できます。
    5. [続行] をクリックし、選択内容を確認します。
    6. [作成] をクリックします。
    7. [付与] をクリックして、選択した鍵で暗号化と復号を行うサービス アカウント権限を付与します。
    Environments 省略可

    このインスタンスに接続する環境を選択します。これを行うには、[Environments] プルダウン リストをクリックして、接続する環境の横にあるチェックボックスをオンにします。これは任意の数の環境に対して実行できます。次に、[OK] をクリックします。

    すべてのインスタンスの環境は、割り当て可能な環境の総数にカウントされます。詳細については、環境と環境グループについてをご覧ください。

    新しいインスタンスの作成時に環境を追加するかどうかは任意です。今すぐ追加しない場合は、代わりに Instances attachment create API または UI を使用して、後で追加および削除できます。環境をアタッチまたは削除するをご覧ください。
    Accepted projects 省略可 [承認済みプロジェクトを追加] をクリックして、1 つ以上の Cloud プロジェクトを選択します。選択したプロジェクトは、インスタンスのサービス アタッチメントにプライベート接続できます。デフォルトでは、Apigee 組織に関連付けられているプロジェクトがこのリストに含まれます。
    Enable logging 省略可 [ロギングを有効にする] をオンに切り替えて、インスタンスの Cloud Logging 上り（内向き）アクセスログを有効にします。これにより、Apigee インフラストラクチャ（外部アプリケーション ロードバランサや Anthos ゲートウェイなど）で Ingress ゲートウェイによって生成されたログを表示し、Apigee API 呼び出しのトラブルシューティングに役立てることができます。

    詳細については、Apigee アクセスログのロギングをご覧ください。
    Filter 省略可 [レスポンス コード] ボックスから HTTP レスポンス コードを選択して、アクセスログのフィルタとして機能させます。

    HTTP レスポンス コードに関係なくすべてのログを含める場合は、None (all HTTP responses) を選択します。

    カスタム フィルタを作成するには、Custom を選択して、次の形式でフィルタを入力します。

    status_code > XX && status code <= YY

    例:

    status_code >= 500 && status_code < 504

    組織で新しいインスタンスを作成できない場合は、Apigee セールスにお問い合わせください。

  5. [Create] をクリックします。

    Apigee は、完了までに 20 分以上かかることのある長時間実行オペレーションを開始します。完了すると、[インスタンス] のインスタンスのリストに新しいインスタンスが表示されます。

Apigee API

VPC ピアリングなしで Apigee がプロビジョニングされた場合は、VPC 以外のピアリングのプロビジョニング手順のランタイム インスタンスを作成するをご覧ください。

Apigee が VPC ピアリングでプロビジョニングされている場合は、VPC ピアリングのプロビジョニング手順のランタイム インスタンスを作成するをご覧ください。

インスタンスの環境を追加または削除する

Google Cloud コンソールの Apigee UI を使用して環境を作成するときに、その環境を既存のインスタンスに割り当てることができます。詳細については、UI での新しい環境の作成をご覧ください。

環境の作成時に環境をインスタンスに接続しなかった場合、またはインスタンスから環境を削除する場合は、次の手順を行います。環境とインスタンスの詳細については、環境とインスタンスをご覧ください。

Google Cloud コンソールで Apigee を使用して環境をインスタンスに関連付けるか、削除するには:

  1. ブラウザで Google Cloud コンソールの Apigee UI を開きます。
  2. [管理] > [インスタンス] を選択します。

  3. 編集するインスタンスをクリックします。

  4. [インスタンスの詳細] ページで、[編集] をクリックします。
  5. [インスタンスの編集] ページで、[環境（省略可）] フィールドをクリックして、インスタンスに関連付ける環境を選択するか、削除する環境の選択を解除します。
  6. [OK] をクリックします。
  7. [保存] をクリックして、変更を保存します。

UI を使用する以外に、Instances attachment create API を使用して環境をインスタンスに関連付けることもできます。例については、コマンドライン プロビジョニング ドキュメントの環境を作成するをご覧ください。

承認済みプロジェクトのリストを編集する

[承認済みプロジェクト] リストからプロジェクトを追加または削除できます。

  1. ブラウザで Google Cloud コンソールの Apigee UI を開きます。
  2. [管理] > [インスタンス] を選択します。

  3. 編集するインスタンスをクリックします。

  4. [インスタンスの詳細] ページで、[編集] をクリックします。
  5. [インスタンスの編集] ページの [承認済みプロジェクト] セクションで、プロジェクトの横にある削除アイコンをクリックして削除します。プロジェクトを追加するには、[承認済みプロジェクトを追加] をクリックし、追加するプロジェクトの ID を入力します。
  6. [保存] をクリックして、変更を保存します。

インスタンスの上り（内向き）アクセスログを有効または無効にする

インスタンスを作成した後、インスタンスの Cloud Logging 上り（内向き）アクセスログを有効または無効にできます。

  1. ブラウザで Google Cloud コンソールの Apigee UI を開きます。
  2. [管理] > [インスタンス] を選択します。

  3. 編集するインスタンスをクリックします。

  4. [インスタンスの詳細] ページで、[編集] をクリックします。
  5. [インスタンスの編集] ページで、[ロギングを有効にする] 切り替えボタンをクリックして機能を無効にします。
  6. [保存] をクリックして、変更を保存します。

インスタンスを削除する

このセクションの説明に従って、Cloud コンソールの Apigee UI を使用して既存のインスタンスを削除します。あるいは、Instances API を使用してインスタンスを削除することもできます。

1 つの Google Cloud リージョンに存在できる Apigee インスタンスは 1 つだけです。インスタンスを削除すると、そのリージョンから完全に削除されます。マルチリージョン インストールもご覧ください。

警告: インスタンスを削除すると、そのインスタンスに関連付けられているすべてのデータが失われます。この手順は元に戻すことができません。ただし、マルチリージョン インストールのように複数のインスタンスがある場合、すべてのインスタンスを削除する場合にのみデータが失われることに注意してください。最後のインスタンスを削除する前に、失いたくないデータを取り出してバックアップするようにしてください。

次のデータは Apigee インスタンスに保存され、インスタンスを削除すると削除されます。

データの種類 説明
鍵管理システム（KMS） KMS データには、API プロダクト、デベロッパー、デベロッパー アプリ、OAuth トークン（アクセス トークン、更新トークン、認証コードなど）、API キーが含まれます。AccessEntity ポリシーまたは関連する Apigee API を使用して、保存するデータを取得します。
Key-Value マップ（KVM） KVM ポリシーで作成または管理できるデータ。KVM の取得をご覧ください。
割り当て 割り当ての定義、バケット、カウンタ。
環境キャッシュ キャッシュに保存されたすべてのデータ。

Cloud コンソールの Apigee UI を使用して Apigee インスタンスを削除するには:

  1. ブラウザで Google Cloud コンソールの Apigee UI を開きます。

  2. [Management] > [Instances] を選択します。

  3. 削除するインスタンスをクリックします。
  4. [インスタンスの詳細] ページで、[削除] をクリックします。