Oracle Cloud Infrastructure Documentation

Listing Consumer Groups

Learn how to list consumer groups in Oracle Cloud Infrastructure Queue Service.

This task documents the steps for listing consumer groups by using the Oracle Cloud Console. To use the API, see ListConsumerGroups in the API Reference. To use the CLI, see the oci queue queue-admin consumer-group-collection list-consumer-groups command in the command line reference for Queue Service.

Here's what you need to do to list consumer groups:
  1. On the Queues list page, find the queue that you want to work with. If you need help finding the list page or the queue, see Listing Queues.
  2. Select Consumer groups.

    You see a list of consumer groups. The default group has (primary) next to its name.

Filtering List Results

Use filters to limit the consumer groups in the list. From the Search and Filter box above the list table, select one or more filters and specify the values that you want to use to narrow the list. In general, the filters correspond to the columns shown in the list table, although some filters represent attributes that aren't shown in the table. The Compartment filter is always displayed next to Applied filters. Change the order of the items in the list table by using the sort icons next to the column names. For more information about searching for resources and managing the columns in the list table, see Listing Resources.

Actions

In the list table, select the name of a consumer group to open its details page, where you can view its status and perform other tasks. To perform an action on a consumer group directly from the list table, select an available option from the Actions menu (three dots) in the row for that consumer group.
  • Change status: Turn the consumer group on or off (enable or disable it). When disabled, the group won't receive new messages, but it's not deleted.
  • Edit: Update the settings for the consumer group, such as its name or filter.
  • Purge: Remove all messages that are waiting in the consumer group.
  • Delete: Permanently remove the consumer group. After it's deleted, you cant recover the group, and any messages waiting in that group are lost.
    Note

    You can only delete consumer groups that you create. You can't delete the default (primary) consumer group.
  • Copy OCID: Copy the unique ID of this consumer group.
    Note

    The OCID of the default (primary) consumer group is the same as the Queue OCID.