List Service Quotas using Confluent CLI¶
You can use the Confluent CLI confluent service-quota list command
(CLI reference)
to list your service quotas using one of the following scopes:
- Organization (
organization) - Environment (
environment) - Kafka cluster (
kafka_cluster) - Service account (
service_account) - User account (
user_account)
You can also filter the list by:
- Quota code
- Network ID
The result is a list of service quotas that includes the following information:
| Column | Description |
|---|---|
| Quota Code | The code for the service quota. |
| Name | The name of the service quota. |
| Scope | Organization, environment, or Kafka cluster. |
| Applied limit | The current limit for the service quota. The applied limit is the value that is currently applied. For the default limit, see Service Quotas for Confluent Cloud. |
| Usage | The current usage for the service quota, if available. |
| Organization | The organization ID for the organization you are signed in to. |
| Environment | The environment ID for the service quota. |
| Kafka cluster | The Kafka cluster ID for the service quota. |
| Network ID | The network ID for the service quota. |
| User | The principal. |
List the service quotas by scope¶
You can use the --scope flag to list service quotas by one of the
available scopes: organization, environment, kafka_cluster,
service_account, user_account.
Organization¶
To list service quotas for the organization you are signed in to, run the
following confluent service-quota list command.
confluent service-quota list organization
The results are displayed in a table format with the columns described in List Service Quotas using Confluent CLI. You can also add filters and specify the output format.
Environment¶
To list the service quotas for an environment in your organization, run the
following confluent service-quota list command, replacing <environment-id>
with your environment ID.
confluent service-quota list environment --environment <environment-id>
Example
confluent service-quota list environment --environment env-nxhjid
Kafka cluster¶
To list the service quotas for a Kafka cluster, run the following
confluent service-quota list command, replacing <kafka-cluster-id>
with the Kafka cluster ID.
confluent service-quota list kafka_cluster --cluster <kafka-cluster-id>
Example
confluent service-quota list kafka_cluster --cluster lkc-1q2w3e4r
Filter the service quota list¶
Optionally, you can filter the service quota list by either the quota code or the network ID.
Quota code¶
To filter the service quota list by quota code, run the following
confluent service-quota list command, replacing <quota-code> with the
quota code.
confluent service-quota list organization --quota-code <quota-code>
The list is filtered to include only the service quotas that match the quota code that you specify.
Example
confluent service-quota list organization --quota-code iam.max_cloud_api_keys.per_org
Network ID¶
To filter the service quota list by network ID, run the following
confluent service-quota list command, replacing <network-id> with the
network ID. The network ID is the ID of the Confluent Cloud network that you want to
filter by.
confluent service-quota list organization --network-id <network-id>
The list returned includes only the service quotas for Confluent Cloud resources within the specified Confluent Cloud network (network ID), including private link access, Peering connections, transit gateway attachments, and Kafka clusters.
To get the network ID, open the Confluent Cloud Console, go to the environment page, click Network management, and find the ID in the Confluent Cloud network.
Example
confluent service-quota list organization --network-id n-gok0y6
Specify the output format¶
You can change the output format of the list by using the --output (or -o)
flag. The default value is human. To specify JSON or YAML as the output format,
add the output flag, replacing <output-format> with json or yaml.
replacing <output-format> with .
confluent service-quota list organization --output <output-format>
When you run this command, the output for your organization is listed in the format you specified.
Example
confluent service-quota list organization --output json