コンパートメント間でのAPIゲートウェイまたはAPIデプロイメントの移動

APIゲートウェイ・サービスを使用してAPIゲートウェイとAPIデプロイメントをコンパートメント間で移動する方法をご紹介します。

APIゲートウェイを作成し、APIデプロイメントを作成することでAPIゲートウェイにAPIをデプロイした後で、いずれかまたは両方をコンパートメント間で移動できます。APIゲートウェイと、それにデプロイされた個々のAPIデプロイメントは、異なるコンパートメントにある場合があります。

APIデプロイメントへのコールは、APIデプロイメント(またはデプロイされているAPIゲートウェイ)が別のコンパートメントに移動中は中断されることに注意してください。移動操作が完了するまで、APIデプロイメントをコールしないでください。

  • コンソールを使用してAPIゲートウェイまたはAPIデプロイメントを別のコンパートメントに移動するには:

    1. コンソールで、ナビゲーション・メニューを開き、「開発者サービス」をクリックします。「API管理」で、「ゲートウェイ」をクリックします。
    2. 作業する権限があるコンパートメントを選択します。
    3. 「ゲートウェイ」ページで、移動するAPIゲートウェイ(または移動するAPIデプロイメントを含むAPIゲートウェイ)の名前をクリックして、「ゲートウェイの詳細」ページを表示します。
    4. 「ゲートウェイの詳細」ページ:

      • APIゲートウェイを移動するには、「リソースの移動」をクリックし、APIゲートウェイの移動先のコンパートメントを選択して「リソースの移動」をクリックし、APIゲートウェイの移動プロセスを開始します。APIゲートウェイ上のAPIデプロイメントは新規コンパートメントに移動されないことに注意してください。
      • APIデプロイメントを移動するには、「リソース」リストから「デプロイメント」を選択し、「リソースの移動」をクリックして、APIデプロイメントの移動先のコンパートメントを選択し、「リソースの移動」をクリックしてAPIデプロイメントの移動プロセスを開始します。

      APIデプロイメント(またはデプロイされているAPIゲートウェイ)が新規コンパートメントに移動中である間は、APIデプロイメントをコールしないでください。

    5. 「ゲートウェイの詳細」ページで「リソース」リストから「作業リクエスト」を選択し、移動操作が完了したことを確認します。

      移動操作が完了したら、APIデプロイメントへのコールを再開します。

  • CLIを使用してAPIゲートウェイおよびAPIデプロイメントを別のコンパートメントに移動するには:

    1. CLIを使用するためにクライアント環境を構成します(APIゲートウェイ開発用のCLIを使用するためのクライアント環境の構成)。
    2. APIゲートウェイを別のコンパートメントに移動するには:

      1. コマンド・プロンプトを開き、oci api-gateway gateway change-compartmentを実行してAPIゲートウェイを移動します:

        oci api-gateway gateway change-compartment --gateway-id <gateway-ocid> --compartment-id <compartment-ocid>

        ここでは:

        例:

        oci api-gateway gateway change-compartment --gateway-id ocid1.apigateway.oc1..aaaaaaaab______hga --compartment-id ocid1.compartment.oc1..aaaaaaaa7______ysq

        APIゲートウェイでのAPIデプロイメントは移動されないことに注意してください。

        コマンドへのレスポンスには、次が含まれます:

        • ライフサイクルの状態(たとえば、ACTIVE、FAILED)。
        • APIゲートウェイの移動のための作業リクエストのID(作業リクエストの詳細は、完了、取消または失敗の後の7日間利用可能です)。

        APIゲートウェイがアクティブになる(またはリクエストが失敗する)までコマンドが制御を返すのを待機するには、次のいずれかまたは両方のパラメータを含めます:

        • --wait-for-state ACTIVE
        • --wait-for-state FAILED

        例:

        oci api-gateway gateway change-compartment --gateway-id ocid1.apigateway.oc1..aaaaaaaab______hga --compartment-id ocid1.compartment.oc1..aaaaaaaa7______ysq" --wait-for-state ACTIVE
      2. (オプション) APIゲートウェイを移動している作業リクエストのステータスを確認するには、次を入力します:

        oci api-gateway work-request get --work-request-id <work-request-ocid>
      3. (オプション) APIゲートウェイを移動している作業リクエストのログを表示するには、次を入力します:

        oci api-gateway work-request-log list --work-request-id <work-request-ocid>
      4. (オプション) APIゲートウェイを移動している作業リクエストに失敗し、エラー・ログを確認する場合、次を入力します:

        oci api-gateway work-request-error --work-request-id <work-request-ocid>
      5. (オプション) APIゲートウェイが移動されたことを確認するには、次のコマンドを入力し、APIゲートウェイの新しいコンパートメントOCIDが予想どおりであることを確認します:

        oci api-gateway gateway get --gateway-id <gateway-ocid>
    3. APIデプロイメントを別のコンパートメントに移動するには:

      1. コマンド・プロンプトを開き、oci api-gateway deployment change-compartmentを実行してAPIデプロイメントを移動します:

        oci api-gateway deployment change-compartment --deployment-id <deployment-ocid> --compartment-id <compartment-ocid>

        ここでは:

        • <deployment-ocid>は、移動するAPIデプロイメントのOCIDです。APIデプロイメントのOCIDを確認するには、APIゲートウェイおよびAPIデプロイメントのリストを参照してください。
        • <compartment-ocid>は、APIデプロイメントを移動するコンパートメントのOCIDです。

        例:

        oci api-gateway deployment change-compartment --deployment-id ocid1.apideployment.oc1..aaaaaaaaab______pwa --compartment-id ocid1.compartment.oc1..aaaaaaaa7______ysq

        コマンドへのレスポンスには、次が含まれます:

        • ライフサイクルの状態(たとえば、ACTIVE、FAILED)。
        • APIデプロイメントを移動する作業リクエストのID(作業リクエストの詳細は、完了、取消または失敗の後の7日間利用可能です)。

        APIデプロイメントがアクティブになる(またはリクエストが失敗する)までコマンドが制御を返すのを待機する場合は、次のパラメータのいずれかまたは両方を含めます:

        • --wait-for-state ACTIVE
        • --wait-for-state FAILED

        例:

        oci api-gateway deployment change-compartment --deployment-id ocid1.apideployment.oc1..aaaaaaaaab______pwa --compartment-id ocid1.compartment.oc1..aaaaaaaa7______ysq --wait-for-state ACTIVE
      2. (オプション) APIデプロイメントを移動している作業リクエストのステータスを確認するには、次を入力します:

        oci api-gateway work-request get --work-request-id <work-request-ocid>
      3. (オプション) APIデプロイメントを移動している作業リクエストのログを表示するには、次を入力します:

        oci api-gateway work-request-log list --work-request-id <work-request-ocid>
      4. (オプション) APIデプロイメントを移動している作業リクエストが失敗し、エラー・ログを確認する場合は、次を入力します:

        oci api-gateway work-request-error --work-request-id <work-request-ocid>
      5. (オプション) APIデプロイメントが移動されたことを確認するには、次のコマンドを入力し、APIデプロイメントの新規コンパートメントOCIDが予想どおりであることを確認します:

        oci api-gateway deployment get --deployment-id <deployment-ocid>

    CLIの使用の詳細は、コマンドライン・インタフェース(CLI)を参照してください。CLIコマンドで使用できるフラグおよびオプションの完全なリストについては、CLIのヘルプを参照してください。

  • 次を実行します。