Apigee 組織を削除する

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

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

このページでは、Google Cloud プロジェクトから Apigee 組織を完全に削除する方法について説明します。これには、Apigee が自動的にクリーンアップしないネットワーク リソースを解放するために必要なフォローアップ手順も含まれます。削除後に必要なクリーンアップは、組織のプロビジョニング方法によって異なります。

  • VPC ピアリングを有効にしてプロビジョニングされた組織には、VPC と Apigee テナント ネットワーク間のサービス ネットワーキング VPC ピアリング接続もあります。この接続と、それに関連付けられている予約済みのピアリング範囲と VPC ネットワークは、組織を削除した後もそのまま残ります。不要になった場合は、個別にクリーンアップする必要があります。フォローアップ: VPC ピアリングでプロビジョニングされた組織をご覧ください。

  • VPC ピアリングが無効になっている組織は、サービス ネットワーク接続ではなく Private Service Connect を使用するため、削除するプロデューサー ピアリングはありません。組織のプロビジョニング時に作成したノースバウンド Private Service Connect ロードバランサ（転送ルール、ターゲット HTTPS プロキシ、URL マップ、バックエンド サービス、PSC ネットワーク エンドポイント グループ、SSL 証明書、予約済み IP アドレス）を削除する必要があります。削除しないと、転送ルールと予約済み IP アドレスに対して引き続き料金が発生します。フォローアップ: VPC ピアリングなしでプロビジョニングされた組織をご覧ください。

始める前にでは、組織がどのカテゴリに該当するかを判断する方法について説明します。

始める前に

必要な IAM 権限

  • Apigee 組織（通常は APIGEE_PROJECT_ID）: apigee.organizations.delete。この権限は roles/apigee.admin ロールに含まれています。Apigee ロールガイドでは、組織を作成、削除、更新できる唯一のロールとして説明されています。

  • また、組織が VPC ピアリングを有効にしてプロビジョニングされ、フォローアップ: VPC ピアリングでプロビジョニングされた組織で説明されているように、サービス ネットワーキング接続、VPC ピアリング範囲、または VPC ネットワークをクリーンアップする予定がある場合: ピアリングされた VPC ネットワークを所有するプロジェクト（ネットワーク プロジェクト。共有 VPC 設定の Apigee プロジェクトとは異なる場合があります）、servicenetworking.services.deleteConnection、compute.globalAddresses.delete、compute.networks.delete。

依存リソースを先に削除する

組織を削除する前に、Apigee で最初に削除する必要があるリソースを削除します。

保存するデータをバックアップする

後で必要になる可能性のある組織スコープのデータやリソースをバックアップします。保持期間が経過すると、組織に保存されているデータは復元できなくなります。

組織で VPC ピアリングを使用しているかどうかを判断する

組織を削除した後に行うクリーンアップは、組織が VPC ピアリングを有効にしてプロビジョニングされたかどうかによって異なります。削除する前に、organizations.get API を使用して組織の構成を読み取ります。

curl -X GET \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  "https://apigee.googleapis.com/v1/organizations/ORGANIZATION"

このページに記載されているこの Apigee REST 呼び出しと他のすべての Apigee REST 呼び出しは、グローバル apigee.googleapis.com エンドポイントをターゲットにしています。組織がデータ所在地のリージョンにある場合は、すべてのサンプルで対応するリージョン エンドポイントに置き換えます。

レスポンスで disableVpcPeering フィールドを探します。

  • レスポンスに "disableVpcPeering": true が含まれている場合、組織は VPC ピアリングなしでプロビジョニングされています。組織を削除したら、フォローアップ: VPC ピアリングなしでプロビジョニングされた組織の手順を行います。

  • フィールドが false であるか、存在しない場合、組織は VPC ピアリングでプロビジョニングされています。同じレスポンスから次の 2 つの追加値を記録します。これらの値はクリーンアップ時に必要になります。

    • authorizedNetwork フィールド。Apigee とピアリングされた VPC ネットワークを識別します。次の 2 つの形式のいずれかで表示されます。
      • ネットワーク プロジェクトとネットワーク名の両方をエンコードする完全なリソースパス projects/NETWORK_PROJECT_ID/global/networks/NETWORK_NAME。この形式は、ネットワークが Apigee 組織とは異なるプロジェクトに存在する場合に使用されます。最も一般的なのは、ネットワークがホスト プロジェクトにある共有 VPC 設定です。
      • ネットワーク名のみ（例: apigee-network）。名前のみが存在する場合、ネットワークは Apigee 組織と同じ Google Cloud プロジェクトに存在します。クリーンアップ手順では、そのプロジェクト（APIGEE_PROJECT_ID）を NETWORK_PROJECT_ID として扱います。
      authorizedNetwork は、VPC ピアリングされた組織にのみ設定されます。
    • VPC ピアリング範囲用に最初に予約したグローバル アドレスの名前（例: apigee-range）。このアドレスは、組織を最初にプロビジョニングしたときに予約したものです。

    組織を削除したら、フォローアップ: VPC ピアリングでプロビジョニングされた組織の手順に沿って操作します。

Apigee 組織を削除する

organizations.delete API を呼び出して、組織を削除します。この呼び出しは長時間実行オペレーションを返します。評価版の組織の場合は即時削除を実行し、有料組織（サブスクリプションまたは従量課金制）の場合は保持期間に従って削除（復元可能）を実行します。

curl -X DELETE \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  "https://apigee.googleapis.com/v1/organizations/ORGANIZATION"

有料組織で最小（24 時間）の保持期間を使用するには、retention クエリ パラメータを追加します。

curl -X DELETE \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  "https://apigee.googleapis.com/v1/organizations/ORGANIZATION?retention=MINIMUM"

レスポンスには、長時間実行オペレーションが含まれます。organizations.operations.get を使用してポーリングできます。

フォローアップ: VPC ピアリングなしでプロビジョニングされた組織

組織の disableVpcPeering フィールドが true の場合、組織を削除してもサービス ネットワーキング リソースは解放されません。VPC ピアリングなしでプロビジョニングされた組織にはサービス ネットワーキング接続がなく、削除するプロデューサー ピアリングがないためです。

組織をプロビジョニングしたときに独自のプロジェクトで作成したノースバウンド Private Service Connect ロードバランサは、引き続き削除する必要があります。これらのリソースは Apigee が所有しているものではなく、organizations.delete がリリースするものでもありません。依存関係の逆順で削除します。

  1. 転送ルール
  2. ターゲット HTTPS プロキシ
  3. URL マップ
  4. バックエンド サービス
  5. PSC ネットワーク エンドポイント グループ
  6. SSL 証明書
  7. 予約済み IP アドレス

ノースバウンドのクリーンアップが完了したら、保持期間と再プロビジョニングに進みます。

フォローアップ: VPC ピアリングを使用してプロビジョニングされた組織

Apigee 組織を削除しても、組織のプロビジョニング時に確立した Service Networking VPC ピアリング接続は解放されません。接続は、予約済みのピアリング範囲とピアリング専用の VPC ネットワークとともに、VPC ネットワークに残ります。これらのリソースが不要になった場合は、正規のプライベート サービス アクセスの構成とサービス ネットワーキングの手順に沿ってクリーンアップを完了します。このセクションの残りの部分では、Apigee の破棄に固有の値と警告のみを説明します。

必要な値を収集する

次のクリーンアップ手順では、同じ少数の値を再利用して、リンクされた Service Networking ガイドと VPC ガイドの手順に組み込みます。各値を 1 回決定してから、シェル変数として設定します。これにより、リンクされたコマンドをそのままコピーできます。

  • NETWORK_PROJECT_ID - ピアリングされた VPC ネットワークを所有するプロジェクト。これは、Apigee サービス プロジェクトと同じとは限りません。共有 VPC の設定では、ネットワークはホスト プロジェクトに存在します。組織で VPC ピアリングを使用しているかどうかを判断するで記録した authorizedNetwork 値から取得します。

    • authorizedNetwork が完全なリソースパス projects/NETWORK_PROJECT_ID/global/networks/NETWORK_NAME の場合は、そのパスから NETWORK_PROJECT_ID を取得します。
    • authorizedNetwork がネットワーク名（apigee-network など）のみの場合、ネットワークは Apigee 組織と同じプロジェクトに存在します。Apigee プロジェクト（APIGEE_PROJECT_ID）を使用します。

  • NETWORK_NAME - VPC ネットワーク名（例: apigee-network）。authorizedNetwork のフルパスから取得するか、authorizedNetwork が名前のみの場合は、そのままの値を使用します。

  • APIGEE_RANGE_NAME - 組織のプロビジョニング時に VPC ピアリング範囲に割り当てられたグローバル アドレスの名前（例: apigee-range）。ピアリングに接続されている予約済み範囲は、gcloud services vpc-peerings list によって返される reservedPeeringRanges リストで確認できます。

  • NETWORK_PROJECT_ID の数値プロジェクト番号。NETWORK_PROJECT_NUMBERService Networking REST API では、consumerNetwork フィールドにプロジェクト番号（プロジェクト ID ではない）が必要です。

    gcloud projects describe NETWORK_PROJECT_ID \
  --format="value(projectNumber)"

リンクされた手順でネットワーク、ネットワーク プロジェクト、コンシューマー ネットワークが求められた場合は、これらの値を代入します。

Apigee の破棄に適用される警告

クリーンアップを完了する

リンク先の手順に沿って、必要な値を収集するの変数を置き換えます。

  • サービス ネットワーキング接続を削除します。プライベート接続を削除するの手順に沿って操作します。Apigee 組織を削除するで Apigee 組織をすでに削除しているため、評価組織のサービス インスタンスを削除するというガイドの前提条件は満たされています。評価組織はすぐに削除されます。有料組織の場合、削除はソフト削除であり、保持期間が経過した後にのみ接続の削除が成功します。保持期間と再プロビジョニングを参照するか、?retention=MINIMUM を使用して組織を削除し、期間を 24 時間に短縮します。この手順でネットワークとネットワーク プロジェクトを求められた場合は、NETWORK_NAME と NETWORK_PROJECT_ID を使用します。基盤となる services.connections.deleteConnection REST 呼び出しで consumerNetwork が求められた場合は、projects/NETWORK_PROJECT_NUMBER/global/networks/NETWORK_NAME を使用します。

  • （省略可）予約済みのピアリング範囲を解放します。APIGEE_RANGE_NAME と NETWORK_PROJECT_ID を使用して、割り振られた IP アドレス範囲を削除するの手順を行います。予約済み範囲は、Apigee 組織と Service Networking 接続が削除された後も保持される、お客様所有のリソースです。そのままにしても、Google Cloud サービスが中断されることはありません。

  • （省略可）VPC ネットワークを削除します。このネットワークのマネージド インスタンス グループまたは内部ロードバランサを介してノースバウンド トラフィックをルーティングした場合は、まずそれらのリソースを削除します。そうしないと、ネットワークの削除が失敗し、依存リソースのエラー（転送ルール、ターゲット プロキシ、URL マップ、バックエンド サービス、マネージド インスタンス グループ、インスタンス テンプレート、ヘルスチェック、ファイアウォール ルール、予約済みアドレス）が発生します。次に、NETWORK_NAME と NETWORK_PROJECT_ID を使用して、VPC ネットワーク ガイドのネットワークを削除するの手順に沿って操作します。

保持期間と再プロビジョニング

organizations.delete リファレンスに記載されているように、

  • Apigee は評価組織を直ちに削除します。
  • Apigee は、有料組織（サブスクリプションまたは従量課金制）を削除（復元可能）します。デフォルトの保持期間は 7 日間です。保持期間中は、Apigee でサポート チケットを提出することで組織を復元できます。削除リクエストで ?retention=MINIMUM を渡すと、この期間が 24 時間に短縮されます。
  • 保持期間中に同じ Google Cloud プロジェクトで Apigee 組織を再作成することはできません。

次のステップ

Apigee のリファレンス:

サービス ネットワーキングとプライベート サービス アクセスのリファレンス: