APIゲートウェイの削除

APIゲートウェイ・サービスで以前に作成したAPIゲートウェイを削除する方法を確認します。

APIゲートウェイを作成した後、APIゲートウェイが不要になった場合があります。APIデプロイメントがない場合は、APIゲートウェイ・サービスから削除できます。

削除されたAPIゲートウェイは、引き続きコンソールに90日間表示され、ステータスは「削除済」になります。90日が経過すると、削除されたAPIゲートウェイは表示されません。

    1. 「ゲートウェイ」リスト・ページで、削除するAPIゲートウェイを検索します。リスト・ページまたはAPIゲートウェイの検索に関するヘルプが必要な場合は、APIゲートウェイのリストを参照してください。
    2. APIゲートウェイの「アクション」メニュー(アクション・メニュー)から、「削除」を選択します。

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

  • CLIを使用してAPIゲートウェイを削除するには:

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

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

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

        ここでは:

        • <gateway-ocid>は、削除するAPIゲートウェイのOCIDです。APIゲートウェイのOCIDを確認するには、APIゲートウェイのリストを参照してください。

        例:

        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>

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

  • DeleteGateway操作を実行して、APIゲートウェイを削除します。