APIゲートウェイまたはAPIデプロイメントの削除

APIゲートウェイ・サービスで以前に作成したAPIゲートウェイおよびAPIデプロイメントを削除する方法をご紹介します。

APIゲートウェイを作成し、APIデプロイメントを作成してAPIゲートウェイにAPIをデプロイした後で、いずれかまたは両方が不要になる場合があります。

  • APIゲートウェイにAPIデプロイメントがない場合、APIゲートウェイ・サービスから削除できます。
  • APIゲートウェイ上の各APIデプロイメントは、一度に1つずつ削除できます。APIデプロイメントを削除すると、そのAPIデプロイメント仕様は完全に削除されます。

削除されたAPIゲートウェイおよびAPIデプロイメントは、引き続き90日間コンソールに表示され、ステータスは「削除されました」になります。90日が経過すると、削除されたAPIゲートウェイおよびAPIデプロイメントは表示されなくなります。

    1. ナビゲーション・メニューを開き、「開発者サービス」をクリックします。「API管理」で、「ゲートウェイ」をクリックします。
    2. 削除するAPIゲートウェイを含むコンパートメント、または削除するAPIデプロイメントがあるコンパートメントを選択します。
    3. APIゲートウェイの名前をクリックして、その詳細ページを開きます。
    4. APIゲートウェイを削除するには、「削除」をクリックします。

      APIゲートウェイが完全に削除されます。APIゲートウェイにAPIデプロイメントがある場合は、APIゲートウェイを削除できないことに注意してください。最初にAPIデプロイメントを削除する必要があります。

    5. APIゲートウェイでAPIデプロイメントを削除するには、「リソース」リストから「デプロイメント」を選択し、削除するAPIデプロイメントの横にある「アクション」メニュー(アクション・メニュー)をクリックして、「削除」を選択します。

      APIデプロイメントとそのAPIデプロイメント仕様が完全に削除されます。

  • CLIを使用してAPIゲートウェイおよびAPIデプロイメントを削除するには:

    1. CLIを使用するためにクライアント環境を構成します(APIゲートウェイ開発用のCLIを使用するためのクライアント環境の構成)。
    2. 既存のAPIゲートウェイを削除するには:

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

        oci api-gateway gateway delete --gateway-id <gateway-ocid>

        ここでは:

        例:

        oci api-gateway gateway delete --gateway-id ocid1.apigateway.oc1..aaaaaaaab______hga

        APIゲートウェイにAPIデプロイメントがある場合(APIゲートウェイ自体とは異なるコンパートメントにあるAPIデプロイメントを含む)、APIゲートウェイを削除できないことに注意してください。最初にAPIデプロイメントを削除する必要があります。

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

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

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

        • --wait-for-state DELETED
        • --wait-for-state FAILED

        例:

        oci api-gateway gateway delete --gateway-id ocid1.apigateway.oc1..aaaaaaaab______hga --wait-for-state DELETED
      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ゲートウェイのライフサイクル状態が「削除済」であることを確認します:

        oci api-gateway gateway get --gateway-id <gateway-ocid>
    3. 既存のAPIデプロイメントを削除するには:

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

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

        ここでは:

        例:

        oci api-gateway deployment delete --deployment-id ocid1.apideployment.oc1..aaaaaaaaab______pwa

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

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

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

        • --wait-for-state DELETED
        • --wait-for-state FAILED

        例:

        oci api-gateway deployment delete --deployment-id ocid1.apideployment.oc1..aaaaaaaaab______pwa --wait-for-state DELETED
      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デプロイメントのライフサイクル状態が「削除済」であることを確認します:

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

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

  • 次を実行します。