1// DescribeGroupsRequest requests metadata for group IDs.
2DescribeGroupsRequest => key 15, max version 5, flexible v5+, group coordinator
3 // Groups is an array of group IDs to request metadata for.
4 Groups: [string]
5 // IncludeAuthorizedOperations, introduced in Kafka 2.3.0, specifies
6 // whether to include a bitfield of AclOperations this client can perform
7 // on the groups. See KIP-430 for more details.
8 IncludeAuthorizedOperations: bool // v3+
9
10// DescribeGroupsResponse is returned from a DescribeGroupsRequest.
11DescribeGroupsResponse =>
12 ThrottleMillis(2) // v1+
13 // Groups is an array of group metadata.
14 Groups: [=>]
15 // ErrorCode is the error code for an individual group in a request.
16 //
17 // GROUP_AUTHORIZATION_FAILED is returned if the client is not authorized
18 // to describe a group.
19 //
20 // INVALID_GROUP_ID is returned if the requested group ID is invalid.
21 //
22 // COORDINATOR_NOT_AVAILABLE is returned if the coordinator for this
23 // group is not yet active.
24 //
25 // COORDINATOR_LOAD_IN_PROGRESS is returned if the group is loading.
26 //
27 // NOT_COORDINATOR is returned if the requested broker is not the
28 // coordinator for this group.
29 ErrorCode: int16
30 // Group is the id of this group.
31 Group: string
32 // State is the state this group is in.
33 State: string
34 // ProtocolType is the "type" of protocol being used for this group.
35 ProtocolType: string
36 // Protocol is the agreed upon protocol for all members in this group.
37 Protocol: string
38 // Members contains members in this group.
39 Members: [=>]
40 // MemberID is the member ID of a member in this group.
41 MemberID: string
42 // InstanceID is the instance ID of this member in the group (KIP-345).
43 InstanceID: nullable-string // v4+
44 // ClientID is the client ID used by this member.
45 ClientID: string
46 // ClientHost is the host this client is running on.
47 ClientHost: string
48 // ProtocolMetadata is the metadata this member included when joining
49 // the group. If using normal (Java-like) consumers, this will be of
50 // type GroupMemberMetadata.
51 ProtocolMetadata: bytes
52 // MemberAssignment is the assignment for this member in the group.
53 // If using normal (Java-like) consumers, this will be of type
54 // GroupMemberAssignment.
55 MemberAssignment: bytes
56 // AuthorizedOperations is a bitfield containing which operations the
57 // the client is allowed to perform on this group.
58 // This is only returned if requested.
59 AuthorizedOperations: int32(-2147483648) // v3+
View as plain text