Send feedback
Method: projects.locations.clusters.consumerGroups.list
Stay organized with collections
Save and categorize content based on your preferences.
Preview
This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section
of the Service Specific Terms .
Pre-GA products and features are available "as is" and might have limited support.
For more information, see the
launch stage descriptions .
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 .
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-24 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
Need to tell us more?
{"lastModified": "Last updated 2024-09-24 UTC."}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-24 UTC."]]