Method: projects.locations.clusters.consumerGroups.list

Lists the consumer groups in a given cluster.

HTTP request

GET https://managedkafka.googleapis.com/v1/{parent=projects/*/locations/*/clusters/*}/consumerGroups

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent cluster whose consumer groups are to be listed. Structured like projects/{project}/locations/{location}/clusters/{cluster}.

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of consumer groups to return. The service may return fewer than this value. If unset or zero, all consumer groups for the parent is returned.
pageToken

string

Optional. A page token, received from a previous consumerGroups.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to consumerGroups.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

Response for consumerGroups.list.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "consumerGroups": [
    {
      object (ConsumerGroup)
    }
  ],
  "nextPageToken": string
}
Fields
consumerGroups[]

object (ConsumerGroup)

The list of consumer group in the requested parent. The order of the consumer groups is unspecified.
nextPageToken

string

A token that can be sent as pageToken to retrieve the next page of results. If this field is omitted, there are no more results.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • managedkafka.consumerGroups.list

For more information, see the IAM documentation.