Method: projects.locations.clusters.consumerGroups.get

Returns the properties of a single consumer group.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the consumer group whose configuration to return. projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ConsumerGroup.

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 name resource:

  • managedkafka.consumerGroups.get

For more information, see the IAM documentation.