GetTelemetrySubscriptions
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
- 71
- Encoded at
- v0
- Flexible versions
- 0+
- Headers
- req v2, resp v1
- Request versions
- 0
- Response versions
- 0
- Request size
- 32 bytes
- Response size
- 49 bytes
framerpc headerrequest bodyRecordBatchRecordresponse bodytagged_fields
Request
GetTelemetrySubscriptionsRequest v0, request header v2, 32 bytes on the wire
byte layout (32 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
GetTelemetrySubscriptionsRequest message v0 [0x0000, 32B] +-- Frame [0x0000, 4B] length-delimited framing | +-- size int32 = 28 [0x0000, 4B] number of bytes that follow, patched after encoding +-- RequestHeader v2 [0x0004, 11B] common request header | +-- request_api_key int16 = 71 (GetTelemetrySubscriptions) [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 +-- GetTelemetrySubscriptionsRequest struct [0x000f, 17B] message body, version 0 +-- ClientInstanceId uuid = 00000000-0000-0000-0000-000000000000 [0x000f, 16B] Unique id for this client instance, must be set to 0 on the first request. +-- tagged_fields uvarint = 0 [0x001f, 1B] number of tagged fields in this struct
kafka message schema (.json)
{ "apiKey": 71, "type": "request", "listeners": ["broker"], "name": "GetTelemetrySubscriptionsRequest", "validVersions": "0", "flexibleVersions": "0+", "fields": [ { "name": "ClientInstanceId", "type": "uuid", "versions": "0+", "about": "Unique id for this client instance, must be set to 0 on the first request." } ] }
Response
GetTelemetrySubscriptionsResponse v0, response header v1, 49 bytes on the wire
byte layout (49 bytes, 16 bytes per row)
0
1
2
3
4
5
6
7
8
9
A
B
C
D
E
F
0000
0010
0020
0030
object tree
GetTelemetrySubscriptionsResponse message v0 [0x0000, 49B] +-- Frame [0x0000, 4B] length-delimited framing | +-- size int32 = 45 [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 +-- GetTelemetrySubscriptionsResponse struct [0x0009, 40B] 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. +-- ClientInstanceId uuid = 00000000-0000-0000-0000-000000000000 [0x000f, 16B] Assigned client instance id if ClientInstanceId was 0 in the request, else 0. +-- SubscriptionId int32 = 0 [0x001f, 4B] Unique identifier for the current subscription set for this client instance. +-- AcceptedCompressionTypes []int8 = 1 element [0x0023, 2B] Compression types that broker accepts for the PushTelemetryRequest. | +-- length uvarint = 2 (compact, n+1) [0x0023, 1B] one sample element follows | +-- int8[0] int8 = 0 [0x0024, 1B] +-- PushIntervalMs int32 = 0 [0x0025, 4B] Configured push interval, which is the lowest configured interval in the cu... +-- TelemetryMaxBytes int32 = 0 [0x0029, 4B] The maximum bytes of binary data the broker accepts in PushTelemetryRequest. +-- DeltaTemporality bool = false [0x002d, 1B] Flag to indicate monotonic/counter metrics are to be emitted as deltas or c... +-- RequestedMetrics []string = 1 element [0x002e, 2B] Requested metrics prefix string match. Empty array: No metrics subscribed, ... | +-- length uvarint = 2 (compact, n+1) [0x002e, 1B] one sample element follows | +-- string[0] string = "" (compact, len+1=1) [0x002f, 1B] +-- tagged_fields uvarint = 0 [0x0030, 1B] number of tagged fields in this struct
kafka message schema (.json)
{ "apiKey": 71, "type": "response", "name": "GetTelemetrySubscriptionsResponse", "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": "ClientInstanceId", "type": "uuid", "versions": "0+", "about": "Assigned client instance id if ClientInstanceId was 0 in the request, else 0." }, { "name": "SubscriptionId", "type": "int32", "versions": "0+", "about": "Unique identifier for the current subscription set for this client instance." }, { "name": "AcceptedCompressionTypes", "type": "[]int8", "versions": "0+", "about": "Compression types that broker accepts for the PushTelemetryRequest." }, { "name": "PushIntervalMs", "type": "int32", "versions": "0+", "about": "Configured push interval, which is the lowest configured interval in the current subscription set." }, { "name": "TelemetryMaxBytes", "type": "int32", "versions": "0+", "about": "The maximum bytes of binary data the broker accepts in PushTelemetryRequest." }, { "name": "DeltaTemporality", "type": "bool", "versions": "0+", "about": "Flag to indicate monotonic/counter metrics are to be emitted as deltas or cumulative values." }, { "name": "RequestedMetrics", "type": "[]string", "versions": "0+", "about": "Requested metrics prefix string match. Empty array: No metrics subscribed, Array[0] empty string: All metrics subscribed." } ] }