Skip to content
m manifester.io
All Kafka APIs

ListClientMetricsResources

This page encodes the smallest legal instance of the request and the response: numeric fields are zero, strings and byte arrays are empty, every array carries exactly one sample element, and any records field holds one empty 61-byte RecordBatch v2. Version 0 is a flexible version, so every struct is terminated by a uvarint tagged-field count and strings and arrays carry compact length-plus-one prefixes. Sizes below include the leading int32 size prefix.

API key
74
Encoded at
v0
Flexible versions
0+
Headers
req v2, resp v1
Request versions
0
Response versions
0
Request size
16 bytes
Response size
19 bytes
framerpc headerrequest bodyRecordBatchRecordresponse bodytagged_fields

Request

ListClientMetricsResourcesRequest v0, request header v2, 16 bytes on the wire

byte layout (16 bytes, 16 bytes per row)

0
1
2
3
4
5
6
7
8
9
A
B
C
D
E
F
0000

object tree

ListClientMetricsResourcesRequest      message v0                                          [0x0000, 16B]
+-- Frame                                                                                  [0x0000, 4B]   length-delimited framing
|   +-- size                           int32            = 12                               [0x0000, 4B]   number of bytes that follow, patched after encoding
+-- RequestHeader                      v2                                                  [0x0004, 11B]  common request header
|   +-- request_api_key                int16            = 74 (ListClientMetricsResources)  [0x0004, 2B]   numeric id of the API being invoked
|   +-- request_api_version            int16            = 0                                [0x0006, 2B]   version of the API being invoked
|   +-- correlation_id                 int32            = 0                                [0x0008, 4B]   echoed back by the broker in the response
|   +-- client_id                      nullable_string  = "" (int16 len=0)                 [0x000c, 2B]   always a non-flexible int16-prefixed string
|   +-- tagged_fields                  uvarint          = 0                                [0x000e, 1B]   number of tagged fields in the header
+-- ListClientMetricsResourcesRequest  struct                                              [0x000f, 1B]   message body, version 0
    +-- tagged_fields                  uvarint          = 0                                [0x000f, 1B]   number of tagged fields in this struct

kafka message schema (.json)

{
  "apiKey": 74,
  "type": "request",
  "listeners": ["broker"],
  "name": "ListClientMetricsResourcesRequest",
  "validVersions": "0",
  "flexibleVersions": "0+",
  "fields": [
  ]
}

Response

ListClientMetricsResourcesResponse v0, response header v1, 19 bytes on the wire

byte layout (19 bytes, 16 bytes per row)

0
1
2
3
4
5
6
7
8
9
A
B
C
D
E
F
0000
0010

object tree

ListClientMetricsResourcesResponse      message v0                                        [0x0000, 19B]
+-- Frame                                                                                 [0x0000, 4B]   length-delimited framing
|   +-- size                            int32                    = 15                     [0x0000, 4B]   number of bytes that follow, patched after encoding
+-- ResponseHeader                      v1                                                [0x0004, 5B]   common response header
|   +-- correlation_id                  int32                    = 0                      [0x0004, 4B]   matches the correlation_id of the request
|   +-- tagged_fields                   uvarint                  = 0                      [0x0008, 1B]   number of tagged fields in the header
+-- ListClientMetricsResourcesResponse  struct                                            [0x0009, 10B]  message body, version 0
    +-- ThrottleTimeMs                  int32                    = 0                      [0x0009, 4B]   The duration in milliseconds for which the request was throttled due to a q...
    +-- ErrorCode                       int16                    = 0                      [0x000d, 2B]   The error code, or 0 if there was no error.
    +-- ClientMetricsResources          []ClientMetricsResource  = 1 element              [0x000f, 3B]   Each client metrics resource in the response.
    |   +-- length                      uvarint                  = 2 (compact, n+1)       [0x000f, 1B]   one sample element follows
    |   +-- ClientMetricsResource[0]    ClientMetricsResource    = struct                 [0x0010, 2B]
    |       +-- Name                    string                   = "" (compact, len+1=1)  [0x0010, 1B]   The resource name.
    |       +-- tagged_fields           uvarint                  = 0                      [0x0011, 1B]   number of tagged fields in this struct
    +-- tagged_fields                   uvarint                  = 0                      [0x0012, 1B]   number of tagged fields in this struct

kafka message schema (.json)

{
  "apiKey": 74,
  "type": "response",
  "name": "ListClientMetricsResourcesResponse",
  "validVersions": "0",
  "flexibleVersions": "0+",
  "fields": [
      { "name": "ThrottleTimeMs", "type": "int32", "versions": "0+",
        "about": "The duration in milliseconds for which the request was throttled due to a quota violation, or zero if the request did not violate any quota." },
      { "name": "ErrorCode", "type": "int16", "versions": "0+",
        "about": "The error code, or 0 if there was no error." },
      { "name": "ClientMetricsResources", "type": "[]ClientMetricsResource", "versions": "0+",
        "about": "Each client metrics resource in the response.", "fields": [
        { "name": "Name", "type": "string", "versions": "0+",
          "about": "The resource name." }
    ]}
  ]
}