Oracle Cloud Infrastructureドキュメント

APIリソースのリスト

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

APIリソースを作成したら、既存のAPIリソースのリストが必要になる場合があります。たとえば、どのAPIリソースが正常に検証されたかを確認できます。

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

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

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

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

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

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

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

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

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

      ここでは:

      • <compartment-ocid>は、APIリソースを含むコンパートメントのOCIDです。

      例:

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

      「アクティブ」ステータスのこれらのAPIリソースのみをリストする場合は、リクエストに--lifecycle-state ACTIVEパラメータを追加します。例:

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

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

  • ListApis操作を実行して、APIリソースをリストします。