APIゲートウェイおよびAPIデプロイメントのリスト
APIゲートウェイ・サービスを使用して既存のAPIゲートウェイおよびデプロイメントをリストする方法を確認します。
APIゲートウェイを作成し、APIデプロイメントを作成してAPIゲートウェイにAPIをデプロイした場合、既存のAPIゲートウェイまたはAPIデプロイメントのリストが必要になることがあります。たとえば、不要になったAPIゲートウェイがあるかどうかを確認したり、そのOCIDによってAPIゲートウェイを迅速に特定したり、APIデプロイメントのOCIDを取得する場合があります。
コンソールを使用してAPIゲートウェイまたはAPIデプロイメントをリストするには:
- コンソールでナビゲーション・メニューを開き、「開発者サービス」をクリックします「API管理」で、「ゲートウェイ」をクリックします
- 作業する権限があるコンパートメントを選択します。
- 現在のリージョンおよびコンパートメントの既存のすべてのAPIゲートウェイ(OCIDを含む)のリストを表示するには、「ゲートウェイ」ページを使用します。
- 個々のAPIゲートウェイの詳細を表示するには、「ゲートウェイ」ページでAPIゲートウェイの名前をクリックして、「ゲートウェイの詳細」ページを表示します。
- APIゲートウェイ(エンドポイント、状態およびOCIDを含む)でAPIデプロイメントのリストを確認するには、「ゲートウェイ」ページでAPIゲートウェイの名前をクリックし、「リソース」リストから「デプロイメント」を選択します。
CLIを使用してコンパートメント内のAPIゲートウェイおよびAPIデプロイメントをリストするには:
- CLIを使用するためにクライアント環境を構成します(APIゲートウェイ開発用のCLIを使用するためのクライアント環境の構成)。
-
コンパートメント内のすべての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
-
コンパートメント内のすべてのAPIデプロイメントをリストするには、コマンド・プロンプトを開き、
oci api-gateway deployment list
を実行してAPIデプロイメントをリストします:oci api-gateway deployment list --compartment-id <compartment-ocid>
ここでは:
<compartment-ocid>
は、APIデプロイメントを含むコンパートメントのOCIDです。
例:
oci api-gateway deployment list --compartment-id ocid1.compartment.oc1..aaaaaaaa7______ysq
「アクティブ」ステータスのこれらのAPIデプロイメントのみをリストする場合は、
--lifecycle-state ACTIVE
パラメータをリクエストに含めます。例:oci api-gateway deployment list --compartment-id ocid1.compartment.oc1..aaaaaaaa7______ysq --lifecycle-state ACTIVE
コンパートメントの特定のAPIゲートウェイのすべてのAPIデプロイメントをリストする場合は、リクエストに
--gateway-id
パラメータを含め、APIゲートウェイのOCIDを指定します。例:oci api-gateway deployment list --compartment-id ocid1.compartment.oc1..aaaaaaaa7______ysq --gateway-id ocid1.apigateway.oc1..aaaaaaaab______hga
CLIの使用の詳細は、コマンドライン・インタフェース(CLI)を参照してください。CLIコマンドで使用できるフラグおよびオプションの完全なリストについては、CLIのヘルプを参照してください。
次を実行します。
- APIゲートウェイをリストするListGateways操作
- APIデプロイメントをリストするListDeployments操作