CreateAcls
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 3 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
- 30
- Encoded at
- v3
- Flexible versions
- 2+
- Headers
- req v2, resp v1
- Request versions
- 1-3
- Response versions
- 1-3
- Request size
- 25 bytes
- Response size
- 19 bytes
framerpc headerrequest bodyRecordBatchRecordresponse bodytagged_fields
Request
CreateAclsRequest v3, request header v2, 25 bytes on the wire
byte layout (25 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
CreateAclsRequest message v3 [0x0000, 25B] +-- Frame [0x0000, 4B] length-delimited framing | +-- size int32 = 21 [0x0000, 4B] number of bytes that follow, patched after encoding +-- RequestHeader v2 [0x0004, 11B] common request header | +-- request_api_key int16 = 30 (CreateAcls) [0x0004, 2B] numeric id of the API being invoked | +-- request_api_version int16 = 3 [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 +-- CreateAclsRequest struct [0x000f, 10B] message body, version 3 +-- Creations []AclCreation = 1 element [0x000f, 9B] The ACLs that we want to create. | +-- length uvarint = 2 (compact, n+1) [0x000f, 1B] one sample element follows | +-- AclCreation[0] AclCreation = struct [0x0010, 8B] | +-- ResourceType int8 = 0 [0x0010, 1B] The type of the resource. | +-- ResourceName string = "" (compact, len+1=1) [0x0011, 1B] The resource name for the ACL. | +-- ResourcePatternType int8 = 0 [0x0012, 1B] The pattern type for the ACL. | +-- Principal string = "" (compact, len+1=1) [0x0013, 1B] The principal for the ACL. | +-- Host string = "" (compact, len+1=1) [0x0014, 1B] The host for the ACL. | +-- Operation int8 = 0 [0x0015, 1B] The operation type for the ACL (read, write, etc.). | +-- PermissionType int8 = 0 [0x0016, 1B] The permission type for the ACL (allow, deny, etc.). | +-- tagged_fields uvarint = 0 [0x0017, 1B] number of tagged fields in this struct +-- tagged_fields uvarint = 0 [0x0018, 1B] number of tagged fields in this struct
kafka message schema (.json)
{ "apiKey": 30, "type": "request", "listeners": ["broker", "controller"], "name": "CreateAclsRequest", // Version 0 was removed in Apache Kafka 4.0, Version 1 is the new baseline. // Version 1 adds resource pattern type. // Version 2 enables flexible versions. // Version 3 adds user resource type. "validVersions": "1-3", "flexibleVersions": "2+", "fields": [ { "name": "Creations", "type": "[]AclCreation", "versions": "0+", "about": "The ACLs that we want to create.", "fields": [ { "name": "ResourceType", "type": "int8", "versions": "0+", "about": "The type of the resource." }, { "name": "ResourceName", "type": "string", "versions": "0+", "about": "The resource name for the ACL." }, { "name": "ResourcePatternType", "type": "int8", "versions": "1+", "default": "3", "about": "The pattern type for the ACL." }, { "name": "Principal", "type": "string", "versions": "0+", "about": "The principal for the ACL." }, { "name": "Host", "type": "string", "versions": "0+", "about": "The host for the ACL." }, { "name": "Operation", "type": "int8", "versions": "0+", "about": "The operation type for the ACL (read, write, etc.)." }, { "name": "PermissionType", "type": "int8", "versions": "0+", "about": "The permission type for the ACL (allow, deny, etc.)." } ]} ] }
Response
CreateAclsResponse v3, 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
CreateAclsResponse message v3 [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 +-- CreateAclsResponse struct [0x0009, 10B] message body, version 3 +-- ThrottleTimeMs int32 = 0 [0x0009, 4B] The duration in milliseconds for which the request was throttled due to a q... +-- Results []AclCreationResult = 1 element [0x000d, 5B] The results for each ACL creation. | +-- length uvarint = 2 (compact, n+1) [0x000d, 1B] one sample element follows | +-- AclCreationResult[0] AclCreationResult = struct [0x000e, 4B] | +-- ErrorCode int16 = 0 [0x000e, 2B] The result error, or zero if there was no error. | +-- ErrorMessage string = "" (compact, len+1=1) [0x0010, 1B] The result message, or null if there was no error. | +-- 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": 30, "type": "response", "name": "CreateAclsResponse", // Version 0 was removed in Apache Kafka 4.0, Version 1 is the new baseline. // Starting in version 1, on quota violation, brokers send out responses before throttling. // Version 2 enables flexible versions. // Version 3 adds user resource type. "validVersions": "1-3", "flexibleVersions": "2+", "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": "Results", "type": "[]AclCreationResult", "versions": "0+", "about": "The results for each ACL creation.", "fields": [ { "name": "ErrorCode", "type": "int16", "versions": "0+", "about": "The result error, or zero if there was no error." }, { "name": "ErrorMessage", "type": "string", "nullableVersions": "0+", "versions": "0+", "about": "The result message, or null if there was no error." } ]} ] }