Oracle Cloud Infrastructureドキュメント

APIゲートウェイのリスト

APIゲートウェイ・サービスを使用して既存のAPIゲートウェイをリストする方法をご紹介します。

APIゲートウェイを作成したら、既存のAPIゲートウェイのリストが必要になる場合があります。たとえば、不要になったAPIゲートウェイがあるかどうかを確認したり、OCIDでAPIゲートウェイをすばやく検索できます。

    1. ナビゲーション・メニューを開き、「開発者サービス」を選択します。「API管理」で、「ゲートウェイ」を選択します。

      「ゲートウェイ」リスト・ページが開きます。選択したコンパートメント内のすべてのAPIゲートウェイが表に表示されます。

    2. 別のコンパートメント内のAPIゲートウェイを表示するには、「コンパートメント」フィルタを使用してコンパートメントを切り替えます。

      コンパートメント内のリソースを表示するには、そのコンパートメントで作業する権限が必要です。使用するコンパートメントがわからない場合は、管理者に連絡してください。詳細は、コンパートメントの理解を参照してください。

    3. 個々のAPIゲートウェイの詳細を表示するには、「ゲートウェイ」リスト・ページでAPIゲートウェイの名前を選択して、「ゲートウェイの詳細」ページを表示します。

  • CLIを使用してコンパートメント内のAPIゲートウェイをリストするには:

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

    2. コンパートメント内のすべてのAPIゲートウェイをリストするには、コマンド・プロンプトを開き、oci api-gateway gateway listを実行してAPIゲートウェイをリストします:

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

      ここでは:

      • <compartment-ocid>は、APIゲートウェイを含むコンパートメントのOCIDです。

      例:

      oci api-gateway gateway list --compartment-id ocid1.compartment.oc1..aaaaaaaa7______ysq

      「アクティブ」ステータスのこれらのAPIゲートウェイのみをリストする場合は、リクエストに--lifecycle-state ACTIVEパラメータを含めます。例:

      oci api-gateway gateway list --compartment-id ocid1.compartment.oc1..aaaaaaaa7______ysq --lifecycle-state ACTIVE

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

  • ListGateways操作を実行して、APIゲートウェイをリストします。