Listing Usage Plans
Find out how to list existing usage plans with the API Gateway service.
Having created usage plans, you might need to list the existing usage plans. For example, you might want to see which usage plans are currently active.
To list the usage plans in a compartment using the CLI:
- Configure your client environment to use the CLI (Configuring Your Client Environment to use the CLI for API Gateway Development).
-
To list all the usage plans in a compartment, open a command prompt and run
oci api-gateway usage-plan list
to list the usage plans:oci api-gateway usage-plan list --compartment-id <compartment-ocid>
where:
<compartment-ocid>
is the OCID of the compartment containing the usage plans.
For example:
oci api-gateway usage-plan list --compartment-id ocid1.compartment.oc1..aaaaaaaa7______ysq
If you want to list just those usage plans with a status of Active, include the
--lifecycle-state ACTIVE
parameter in the request. For example:oci api-gateway usage-plan list --compartment-id ocid1.compartment.oc1..aaaaaaaa7______ysq --lifecycle-state ACTIVE
For more information about using the CLI, see Command Line Interface (CLI). For a complete list of flags and options available for CLI commands, see CLI Help.
Run the ListUsagePlans operation to list usage plans.