Strimzi HTTP Bridge for Apache Kafka
1. Overview
The Strimzi HTTP Bridge for Apache Kafka provides a REST API for integrating HTTP based client applications with a Kafka cluster. You can use the API to create and manage consumers and send and receive records over HTTP rather than the native Kafka protocol.
1.1. Version information
Version : 0.1.0
1.2. Contact information
Contact Email : cncf-strimzi-dev@lists.cncf.io
1.3. License information
License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0.html
Terms of service : http://swagger.io/terms/
1.4. URI scheme
Host : bridge.swagger.io
BasePath : /
Schemes : HTTP
1.5. Tags
-
Consumers : Consumer operations to create consumers in your Kafka cluster and perform common actions, such as subscribing to topics, retrieving processed records, and committing offsets.
-
Producer : Producer operations to send records to a specified topic or topic partition.
-
Seek : Seek operations that enable a consumer to begin receiving messages from a given offset position.
-
Topics : Topic operations to send messages to a specified topic or topic partition, optionally including message keys in requests. You can also retrieve topics and topic metadata.
1.6. Consumes
-
application/json
1.7. Produces
-
application/json
1.8. External Docs
Description : Find out more about the Strimzi HTTP Bridge
URL : https://strimzi.io/documentation/
2. Definitions
2.1. AssignedTopicPartitions
Type : < string, < integer (int32) > array > map
2.3. Consumer
Name | Description | Schema |
---|---|---|
auto.offset.reset |
Resets the offset position for the consumer.
If set to |
string |
consumer.request.timeout.ms |
Sets the maximum amount of time, in milliseconds, for the consumer to wait for messages for a request. If the timeout period is reached without a response, an error is returned. |
integer |
enable.auto.commit |
If set to |
boolean |
fetch.min.bytes |
Sets the minimum ammount of data, in bytes, for the consumer to receive. The broker waits until the data to send exceeds this amount. |
integer |
format |
The allowable message format for the consumer, which can be |
string |
name |
The unique name for the consumer instance. The name is unique within the scope of the consumer group. The name is used in URLs. |
string |
2.4. ConsumerRecord
Name | Schema |
---|---|
headers |
|
key |
string |
offset |
integer (int64) |
partition |
integer (int32) |
topic |
string |
value |
string |
2.5. ConsumerRecordList
Type : < ConsumerRecord > array
2.6. CreatedConsumer
Name | Description | Schema |
---|---|---|
base_uri |
Base URI used to construct URIs for subsequent requests against this consumer instance. |
string |
instance_id |
Unique ID for the consumer instance in the group. |
string |
2.7. Error
Name | Schema |
---|---|
error_code |
integer (int32) |
message |
string |
2.8. KafkaHeader
Name | Description | Schema |
---|---|---|
key |
string |
|
value |
The header value in binary format, base64-encoded |
string (byte) |
2.9. KafkaHeaderList
Type : < KafkaHeader > array
2.10. OffsetCommitSeek
Name | Schema |
---|---|
offset |
integer (int64) |
partition |
integer (int32) |
topic |
string |
2.11. OffsetCommitSeekList
Name | Schema |
---|---|
offsets |
< OffsetCommitSeek > array |
2.12. OffsetRecordSent
Name | Schema |
---|---|
offset |
integer (int64) |
partition |
integer (int32) |
2.13. OffsetRecordSentList
Name | Schema |
---|---|
offsets |
< OffsetRecordSent > array |
2.14. OffsetsSummary
Name | Schema |
---|---|
beginning_offset |
integer (int64) |
end_offset |
integer (int64) |
2.15. Partition
Name | Schema |
---|---|
partition |
integer (int32) |
topic |
string |
2.16. PartitionMetadata
Name | Schema |
---|---|
leader |
integer (int32) |
partition |
integer (int32) |
replicas |
< Replica > array |
2.17. Partitions
Name | Schema |
---|---|
partitions |
< Partition > array |
2.18. ProducerRecord
Name | Schema |
---|---|
headers |
|
partition |
integer (int32) |
2.19. ProducerRecordList
Name | Schema |
---|---|
records |
< ProducerRecord > array |
2.20. ProducerRecordToPartition
Type : object
2.21. ProducerRecordToPartitionList
Name | Schema |
---|---|
records |
< ProducerRecordToPartition > array |
2.22. Replica
Name | Schema |
---|---|
broker |
integer (int32) |
in_sync |
boolean |
leader |
boolean |
2.23. SubscribedTopicList
Name | Schema |
---|---|
partitions |
< AssignedTopicPartitions > array |
topics |
2.24. TopicMetadata
Name | Description | Schema |
---|---|---|
configs |
Per-topic configuration overrides |
< string, string > map |
name |
Name of the topic |
string |
partitions |
< PartitionMetadata > array |
2.25. Topics
Name | Description | Schema |
---|---|---|
topic_pattern |
A regex topic pattern for matching multiple topics |
string |
topics |
< string > array |
3. Paths
3.1. GET /
3.1.1. Description
Retrieves information about the Kafka Bridge instance, in JSON format.
3.1.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Information about Kafka Bridge instance. |
3.1.3. Produces
-
application/json
3.1.4. Example HTTP response
Response 200
{
"bridge_version" : "0.16.0"
}
3.2. POST /consumers/{groupid}
3.2.1. Description
Creates a consumer instance in the given consumer group. You can optionally specify a consumer name and supported configuration options. It returns a base URI which must be used to construct URLs for subsequent requests against this consumer instance.
3.2.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
groupid |
ID of the consumer group in which to create the consumer. |
string |
Body |
body |
Name and configuration of the consumer. The name is unique within the scope of the consumer group. If a name is not specified, a randomly generated name is assigned. All parameters are optional. The supported configuration options are shown in the following example. |
3.2.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Consumer created successfully. |
|
409 |
A consumer instance with the specified name already exists in the Kafka Bridge. |
|
422 |
One or more consumer configuration options have invalid values. |
3.2.4. Consumes
-
application/vnd.kafka.v2+json
3.2.5. Produces
-
application/vnd.kafka.v2+json
3.2.6. Tags
-
Consumers
3.2.7. Example HTTP request
Request body
{
"name" : "consumer1",
"format" : "binary",
"auto.offset.reset" : "earliest",
"enable.auto.commit" : false,
"fetch.min.bytes" : 512,
"consumer.request.timeout.ms" : 30000
}
3.2.8. Example HTTP response
Response 200
{
"application/vnd.kafka.v2+json" : {
"instance_id" : "consumer1",
"base_uri" : "http://localhost:8080/consumers/my-group/instances/consumer1"
}
}
Response 409
{
"application/vnd.kafka.v2+json" : {
"error_code" : 409,
"message" : "A consumer instance with the specified name already exists in the Kafka Bridge."
}
}
Response 422
{
"application/vnd.kafka.v2+json" : {
"error_code" : 422,
"message" : "One or more consumer configuration options have invalid values."
}
}
3.3. DELETE /consumers/{groupid}/instances/{name}
3.3.1. Description
Deletes a specified consumer instance. The request for this operation MUST use the base URL (including the host and port) returned in the response from the POST
request to /consumers/{groupid}
that was used to create this consumer.
3.3.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
groupid |
ID of the consumer group to which the consumer belongs. |
string |
Path |
name |
Name of the consumer to delete. |
string |
3.3.3. Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Consumer removed successfully. |
No Content |
404 |
The specified consumer instance was not found. |
3.3.4. Consumes
-
application/vnd.kafka.v2+json
3.3.5. Produces
-
application/vnd.kafka.v2+json
3.3.6. Tags
-
Consumers
3.3.7. Example HTTP response
Response 404
{
"application/vnd.kafka.v2+json" : {
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
}
3.4. POST /consumers/{groupid}/instances/{name}/assignments
3.4.1. Description
Assigns one or more topic partitions to a consumer.
3.4.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
groupid |
ID of the consumer group to which the consumer belongs. |
string |
Path |
name |
Name of the consumer to assign topic partitions to. |
string |
Body |
body |
List of topic partitions to assign to the consumer. |
3.4.3. Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Partitions assigned successfully. |
No Content |
404 |
The specified consumer instance was not found. |
|
409 |
Subscriptions to topics, partitions, and patterns are mutually exclusive. |
3.4.4. Consumes
-
application/vnd.kafka.v2+json
3.4.5. Produces
-
application/vnd.kafka.v2+json
3.4.6. Tags
-
Consumers
3.4.7. Example HTTP request
Request body
{
"partitions" : [ {
"topic" : "topic",
"partition" : 0
}, {
"topic" : "topic",
"partition" : 1
} ]
}
3.4.8. Example HTTP response
Response 404
{
"application/vnd.kafka.v2+json" : {
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
}
Response 409
{
"application/vnd.kafka.v2+json" : {
"error_code" : 409,
"message" : "Subscriptions to topics, partitions, and patterns are mutually exclusive."
}
}
3.5. POST /consumers/{groupid}/instances/{name}/offsets
3.5.1. Description
Commits a list of consumer offsets. To commit offsets for all records fetched by the consumer, leave the request body empty.
3.5.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
groupid |
ID of the consumer group to which the consumer belongs. |
string |
Path |
name |
Name of the consumer. |
string |
Body |
body |
List of consumer offsets to commit to the consumer offsets commit log. You can specify one or more topic partitions to commit offsets for. |
3.5.3. Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Commit made successfully. |
No Content |
404 |
The specified consumer instance was not found. |
3.5.4. Consumes
-
application/vnd.kafka.v2+json
3.5.5. Produces
-
application/vnd.kafka.v2+json
3.5.6. Tags
-
Consumers
3.5.7. Example HTTP request
Request body
{
"offsets" : [ {
"topic" : "topic",
"partition" : 0,
"offset" : 15
}, {
"topic" : "topic",
"partition" : 1,
"offset" : 42
} ]
}
3.5.8. Example HTTP response
Response 404
{
"application/vnd.kafka.v2+json" : {
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
}
3.6. POST /consumers/{groupid}/instances/{name}/positions
3.6.1. Description
Configures a subscribed consumer to fetch offsets from a particular offset the next time it fetches a set of records from a given topic partition. This overrides the default fetch behavior for consumers. You can specify one or more topic partitions.
3.6.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
groupid |
ID of the consumer group to which the consumer belongs. |
string |
Path |
name |
Name of the subscribed consumer. |
string |
Body |
body |
List of partition offsets from which the subscribed consumer will next fetch records. |
3.6.3. Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Seek performed successfully. |
No Content |
404 |
The specified consumer instance was not found, or the specified consumer instance did not have one of the specified partitions assigned. |
3.6.4. Consumes
-
application/vnd.kafka.v2+json
3.6.5. Produces
-
application/vnd.kafka.v2+json
3.6.6. Tags
-
Consumers
-
Seek
3.6.7. Example HTTP request
Request body
{
"offsets" : [ {
"topic" : "topic",
"partition" : 0,
"offset" : 15
}, {
"topic" : "topic",
"partition" : 1,
"offset" : 42
} ]
}
3.6.8. Example HTTP response
Response 404
{
"application/vnd.kafka.v2+json" : {
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
}
3.7. POST /consumers/{groupid}/instances/{name}/positions/beginning
3.7.1. Description
Configures a subscribed consumer to seek (and subsequently read from) the first offset in one or more given topic partitions.
3.7.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
groupid |
ID of the consumer group to which the subscribed consumer belongs. |
string |
Path |
name |
Name of the subscribed consumer. |
string |
Body |
body |
List of topic partitions to which the consumer is subscribed. The consumer will seek the first offset in the specified partitions. |
3.7.3. Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Seek to the beginning performed successfully. |
No Content |
404 |
The specified consumer instance was not found, or the specified consumer instance did not have one of the specified partitions assigned. |
3.7.4. Consumes
-
application/vnd.kafka.v2+json
3.7.5. Produces
-
application/vnd.kafka.v2+json
3.7.6. Tags
-
Consumers
-
Seek
3.7.7. Example HTTP request
Request body
{
"partitions" : [ {
"topic" : "topic",
"partition" : 0
}, {
"topic" : "topic",
"partition" : 1
} ]
}
3.7.8. Example HTTP response
Response 404
{
"application/vnd.kafka.v2+json" : {
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
}
3.8. POST /consumers/{groupid}/instances/{name}/positions/end
3.8.1. Description
Configures a subscribed consumer to seek (and subsequently read from) the offset at the end of one or more of the given topic partitions.
3.8.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
groupid |
ID of the consumer group to which the subscribed consumer belongs. |
string |
Path |
name |
Name of the subscribed consumer. |
string |
Body |
body |
List of topic partitions to which the consumer is subscribed. The consumer will seek the last offset in the specified partitions. |
3.8.3. Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Seek to the end performed successfully. |
No Content |
404 |
The specified consumer instance was not found, or the specified consumer instance did not have one of the specified partitions assigned. |
3.8.4. Consumes
-
application/vnd.kafka.v2+json
3.8.5. Produces
-
application/vnd.kafka.v2+json
3.8.6. Tags
-
Consumers
-
Seek
3.8.7. Example HTTP request
Request body
{
"partitions" : [ {
"topic" : "topic",
"partition" : 0
}, {
"topic" : "topic",
"partition" : 1
} ]
}
3.8.8. Example HTTP response
Response 404
{
"application/vnd.kafka.v2+json" : {
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
}
3.9. GET /consumers/{groupid}/instances/{name}/records
3.9.1. Description
Retrieves records for a subscribed consumer, including message values, topics, and partitions. The request for this operation MUST use the base URL (including the host and port) returned in the response from the POST
request to /consumers/{groupid}
that was used to create this consumer.
3.9.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
groupid |
ID of the consumer group to which the subscribed consumer belongs. |
string |
Path |
name |
Name of the subscribed consumer to retrieve records from. |
string |
Query |
max_bytes |
The maximum size, in bytes, of unencoded keys and values that can be included in the response. Otherwise, an error response with code 422 is returned. |
integer |
Query |
timeout |
The maximum amount of time, in milliseconds, that the HTTP Bridge spends retrieving records before timing out the request. |
integer |
3.9.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Poll request executed successfully. |
|
404 |
The specified consumer instance was not found. |
|
406 |
The |
|
422 |
Response exceeds the maximum number of bytes the consumer can receive |
3.9.4. Produces
-
application/vnd.kafka.json.v2+json
-
application/vnd.kafka.binary.v2+json
-
application/vnd.kafka.v2+json
3.9.5. Tags
-
Consumers
3.9.6. Example HTTP response
Response 200
{
"application/vnd.kafka.json.v2+json" : [ {
"topic" : "topic",
"key" : "key1",
"value" : {
"foo" : "bar"
},
"partition" : 0,
"offset" : 2
}, {
"topic" : "topic",
"key" : "key2",
"value" : [ "foo2", "bar2" ],
"partition" : 1,
"offset" : 3
} ],
"application/vnd.kafka.binary.v2+json" : "[\n {\n \"topic\": \"test\",\n \"key\": \"a2V5\",\n \"value\": \"Y29uZmx1ZW50\",\n \"partition\": 1,\n \"offset\": 100,\n },\n {\n \"topic\": \"test\",\n \"key\": \"a2V5\",\n \"value\": \"a2Fma2E=\",\n \"partition\": 2,\n \"offset\": 101,\n }\n]"
}
Response 404
{
"application/vnd.kafka.v2+json" : {
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
}
Response 406
{
"application/vnd.kafka.v2+json" : {
"error_code" : 406,
"message" : "The `format` used in the consumer creation request does not match the embedded format in the Accept header of this request."
}
}
Response 422
{
"application/vnd.kafka.v2+json" : {
"error_code" : 422,
"message" : "Response exceeds the maximum number of bytes the consumer can receive"
}
}
3.10. POST /consumers/{groupid}/instances/{name}/subscription
3.10.1. Description
Subscribes a consumer to one or more topics. You can describe the topics to which the consumer will subscribe in a list (of Topics
type) or as a topic_pattern
field. Each call replaces the subscriptions for the subscriber.
3.10.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
groupid |
ID of the consumer group to which the subscribed consumer belongs. |
string |
Path |
name |
Name of the consumer to unsubscribe from topics. |
string |
Body |
body |
List of topics to which the consumer will subscribe. |
3.10.3. Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Consumer subscribed successfully. |
No Content |
404 |
The specified consumer instance was not found. |
|
409 |
Subscriptions to topics, partitions, and patterns are mutually exclusive. |
|
422 |
A list (of |
3.10.4. Consumes
-
application/vnd.kafka.v2+json
3.10.5. Produces
-
application/vnd.kafka.v2+json
3.10.6. Tags
-
Consumers
3.10.7. Example HTTP request
Request body
{
"topics" : [ "topic1", "topic2" ]
}
3.10.8. Example HTTP response
Response 404
{
"application/vnd.kafka.v2+json" : {
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
}
Response 409
{
"application/vnd.kafka.v2+json" : {
"error_code" : 409,
"message" : "Subscriptions to topics, partitions, and patterns are mutually exclusive."
}
}
Response 422
{
"application/vnd.kafka.v2+json" : {
"error_code" : 422,
"message" : "A list (of Topics type) or a topic_pattern must be specified."
}
}
3.11. GET /consumers/{groupid}/instances/{name}/subscription
3.11.1. Description
Retrieves a list of the topics to which the consumer is subscribed.
3.11.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
groupid |
ID of the consumer group to which the subscribed consumer belongs. |
string |
Path |
name |
Name of the consumer to unsubscribe from topics. |
string |
3.11.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List of subscribed topics and partitions. |
|
404 |
The specified consumer instance was not found. |
3.11.4. Produces
-
application/vnd.kafka.v2+json
3.11.5. Tags
-
Consumers
3.11.6. Example HTTP response
Response 200
{
"topics" : [ "my-topic1", "my-topic2" ],
"partitions" : [ {
"my-topic1" : [ 1, 2, 3 ]
}, {
"my-topic2" : [ 1 ]
} ]
}
Response 404
{
"application/vnd.kafka.v2+json" : {
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
}
3.12. DELETE /consumers/{groupid}/instances/{name}/subscription
3.12.1. Description
Unsubscribes a consumer from all topics.
3.12.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
groupid |
ID of the consumer group to which the subscribed consumer belongs. |
string |
Path |
name |
Name of the consumer to unsubscribe from topics. |
string |
3.12.3. Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Consumer unsubscribed successfully. |
No Content |
404 |
The specified consumer instance was not found. |
3.12.4. Tags
-
Consumers
3.12.5. Example HTTP response
Response 404
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
3.13. GET /healthy
3.13.1. Description
Check if the bridge is running. This does not necessarily imply that it is ready to accept requests.
3.13.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
The bridge is healthy |
No Content |
3.14. GET /openapi
3.14.1. Description
Retrieves the OpenAPI v2 specification in JSON format.
3.14.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OpenAPI v2 specification in JSON format retrieved successfully. |
string |
3.14.3. Produces
-
application/json
3.15. GET /ready
3.15.1. Description
Check if the bridge is ready and can accept requests.
3.15.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
The bridge is ready |
No Content |
3.16. GET /topics
3.16.1. Description
Retrieves a list of all topics.
3.16.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List of topics. |
< string > array |
3.16.3. Produces
-
application/vnd.kafka.v2+json
3.16.4. Tags
-
Topics
3.16.5. Example HTTP response
Response 200
{
"application/vnd.kafka.v2+json" : [ "topic1", "topic2" ]
}
3.17. POST /topics/{topicname}
3.17.1. Description
Sends one or more records to a given topic, optionally specifying a partition, key, or both.
3.17.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
topicname |
Name of the topic to send records to or retrieve metadata from. |
string |
Body |
body |
3.17.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Records sent successfully. |
|
404 |
The specified topic was not found. |
|
422 |
The record list is not valid. |
3.17.4. Consumes
-
application/vnd.kafka.json.v2+json
-
application/vnd.kafka.binary.v2+json
3.17.5. Produces
-
application/vnd.kafka.v2+json
3.17.6. Tags
-
Producer
-
Topics
3.17.7. Example HTTP request
Request body
{
"records" : [ {
"key" : "key1",
"value" : "value1"
}, {
"value" : "value2",
"partition" : 1
}, {
"value" : "value3"
} ]
}
3.17.8. Example HTTP response
Response 200
{
"application/vnd.kafka.v2+json" : {
"offsets" : [ {
"partition" : 2,
"offset" : 0
}, {
"partition" : 1,
"offset" : 1
}, {
"partition" : 2,
"offset" : 2
} ]
}
}
Response 404
{
"application/vnd.kafka.v2+json" : {
"error_code" : 404,
"message" : "The specified topic was not found."
}
}
Response 422
{
"application/vnd.kafka.v2+json" : {
"error_code" : 422,
"message" : "The record list contains invalid records."
}
}
3.18. GET /topics/{topicname}
3.18.1. Description
Retrieves the metadata about a given topic.
3.18.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
topicname |
Name of the topic to send records to or retrieve metadata from. |
string |
3.18.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Topic metadata |
3.18.4. Produces
-
application/vnd.kafka.v2+json
3.18.5. Tags
-
Topics
3.18.6. Example HTTP response
Response 200
{
"application/vnd.kafka.v2+json" : {
"name" : "topic",
"offset" : 2,
"configs" : {
"cleanup.policy" : "compact"
},
"partitions" : [ {
"partition" : 1,
"leader" : 1,
"replicas" : [ {
"broker" : 1,
"leader" : true,
"in_sync" : true
}, {
"broker" : 2,
"leader" : false,
"in_sync" : true
} ]
}, {
"partition" : 2,
"leader" : 2,
"replicas" : [ {
"broker" : 1,
"leader" : false,
"in_sync" : true
}, {
"broker" : 2,
"leader" : true,
"in_sync" : true
} ]
} ]
}
}
3.19. GET /topics/{topicname}/partitions
3.19.1. Description
Retrieves a list of partitions for the topic.
3.19.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
topicname |
Name of the topic to send records to or retrieve metadata from. |
string |
3.19.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
List of partitions |
< PartitionMetadata > array |
404 |
The specified topic was not found. |
3.19.4. Produces
-
application/vnd.kafka.v2+json
3.19.5. Tags
-
Topics
3.19.6. Example HTTP response
Response 200
{
"application/vnd.kafka.v2+json" : [ {
"partition" : 1,
"leader" : 1,
"replicas" : [ {
"broker" : 1,
"leader" : true,
"in_sync" : true
}, {
"broker" : 2,
"leader" : false,
"in_sync" : true
} ]
}, {
"partition" : 2,
"leader" : 2,
"replicas" : [ {
"broker" : 1,
"leader" : false,
"in_sync" : true
}, {
"broker" : 2,
"leader" : true,
"in_sync" : true
} ]
} ]
}
Response 404
{
"application/vnd.kafka.v2+json" : {
"error_code" : 404,
"message" : "The specified topic was not found."
}
}
3.20. POST /topics/{topicname}/partitions/{partitionid}
3.20.1. Description
Sends one or more records to a given topic partition, optionally specifying a key.
3.20.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
partitionid |
ID of the partition to send records to or retrieve metadata from. |
integer |
Path |
topicname |
Name of the topic to send records to or retrieve metadata from. |
string |
Body |
body |
List of records to send to a given topic partition, including a value (required) and a key (optional). |
3.20.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Records sent successfully. |
|
404 |
The specified topic partition was not found. |
|
422 |
The record is not valid. |
3.20.4. Consumes
-
application/vnd.kafka.json.v2+json
-
application/vnd.kafka.binary.v2+json
3.20.5. Produces
-
application/vnd.kafka.v2+json
3.20.6. Tags
-
Producer
-
Topics
3.20.7. Example HTTP request
Request body
{
"records" : [ {
"key" : "key1",
"value" : "value1"
}, {
"value" : "value2"
} ]
}
3.20.8. Example HTTP response
Response 200
{
"application/vnd.kafka.v2+json" : {
"offsets" : [ {
"partition" : 2,
"offset" : 0
}, {
"partition" : 1,
"offset" : 1
}, {
"partition" : 2,
"offset" : 2
} ]
}
}
Response 404
{
"application/vnd.kafka.v2+json" : {
"error_code" : 404,
"message" : "The specified topic partition was not found."
}
}
Response 422
{
"application/vnd.kafka.v2+json" : {
"error_code" : 422,
"message" : "The record is not valid."
}
}
3.21. GET /topics/{topicname}/partitions/{partitionid}
3.21.1. Description
Retrieves partition metadata for the topic partition.
3.21.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
partitionid |
ID of the partition to send records to or retrieve metadata from. |
integer |
Path |
topicname |
Name of the topic to send records to or retrieve metadata from. |
string |
3.21.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Partition metadata |
|
404 |
The specified topic partition was not found. |
3.21.4. Produces
-
application/vnd.kafka.v2+json
3.21.5. Tags
-
Topics
3.21.6. Example HTTP response
Response 200
{
"application/vnd.kafka.v2+json" : {
"partition" : 1,
"leader" : 1,
"replicas" : [ {
"broker" : 1,
"leader" : true,
"in_sync" : true
}, {
"broker" : 2,
"leader" : false,
"in_sync" : true
} ]
}
}
Response 404
{
"application/vnd.kafka.v2+json" : {
"error_code" : 404,
"message" : "The specified topic partition was not found."
}
}
3.22. GET /topics/{topicname}/partitions/{partitionid}/offsets
3.22.1. Description
Retrieves a summary of the offsets for the topic partition.
3.22.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
partitionid |
ID of the partition. |
integer |
Path |
topicname |
Name of the topic containing the partition. |
string |
3.22.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
A summary of the offsets for the topic partition. |
|
404 |
The specified topic partition was not found. |
3.22.4. Produces
-
application/vnd.kafka.v2+json
3.22.5. Tags
-
Topics
3.22.6. Example HTTP response
Response 200
{
"application/vnd.kafka.v2+json" : {
"beginning_offset" : 10,
"end_offset" : 50
}
}
Response 404
{
"application/vnd.kafka.v2+json" : {
"error_code" : 404,
"message" : "The specified topic partition was not found."
}
}
Revised on 2021-12-12 16:00:59 +0100