홈
제품
Streams for Apache Kafka
2.1
Using the AMQ Streams Kafka Bridge
Chapter 3. AMQ Streams Kafka Bridge API Reference

이 콘텐츠는 선택한 언어로 제공되지 않습니다.

Chapter 3. AMQ Streams Kafka Bridge API Reference

3.1. Overview
링크 복사

The AMQ Streams Kafka Bridge 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.

3.1.1. Version information
링크 복사

Version : 0.1.0

3.1.2. 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.

3.1.3. Consumes
링크 복사

application/json

3.1.4. Produces
링크 복사

application/json

3.2. Definitions
링크 복사

3.2.1. AssignedTopicPartitions
링크 복사

Type : < string, < integer (int32) > array > map

3.2.2. BridgeInfo
링크 복사

Information about Kafka Bridge instance.

Expand

Name	Schema
bridge_version optional	string

3.2.3. Consumer
링크 복사

Expand

Name	Description	Schema
auto.offset.reset optional	Resets the offset position for the consumer. If set to `earliest`, messages are read from the first offset. If set to `latest`, messages are read from the latest offset.	string
consumer.request.timeout.ms optional	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 optional	If set to `true`, message offsets are committed automatically for the consumer. If set to `false`, message offsets must be committed manually.	boolean
fetch.min.bytes optional	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 optional	The allowable message format for the consumer, which can be `binary` (default) or `json`. The messages are converted into a JSON format.	string
isolation.level optional	If set to `read_uncommitted`, all transaction records are retrieved. If set to `read_committed` , the records from committed transactions are retrieved.	string
name optional	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

3.2.4. ConsumerRecord
링크 복사

Expand

Name	Schema
headers optional	KafkaHeaderList
key optional	string
offset optional	integer (int64)
partition optional	integer (int32)
topic optional	string
value optional	string

3.2.5. ConsumerRecordList
링크 복사

Type : < ConsumerRecord > array

3.2.6. CreatedConsumer
링크 복사

Expand

Name	Description	Schema
base_uri optional	Base URI used to construct URIs for subsequent requests against this consumer instance.	string
instance_id optional	Unique ID for the consumer instance in the group.	string

3.2.7. Error
링크 복사

Expand

Name	Schema
error_code optional	integer (int32)
message optional	string

3.2.8. KafkaHeader
링크 복사

Expand

Name	Description	Schema
key required		string
value required	The header value in binary format, base64-encoded Pattern : `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`	string (byte)

3.2.9. KafkaHeaderList
링크 복사

Type : < KafkaHeader > array

3.2.10. OffsetCommitSeek
링크 복사

Expand

Name	Schema
offset required	integer (int64)
partition required	integer (int32)
topic required	string

3.2.11. OffsetCommitSeekList
링크 복사

Expand

Name	Schema
offsets optional	< OffsetCommitSeek > array

3.2.12. OffsetRecordSent
링크 복사

Expand

Name	Schema
offset optional	integer (int64)
partition optional	integer (int32)

3.2.13. OffsetRecordSentList
링크 복사

Expand

Name	Schema
offsets optional	< OffsetRecordSent > array

3.2.14. OffsetsSummary
링크 복사

Expand

Name	Schema
beginning_offset optional	integer (int64)
end_offset optional	integer (int64)

3.2.15. Partition
링크 복사

Expand

Name	Schema
partition optional	integer (int32)
topic optional	string

3.2.16. PartitionMetadata
링크 복사

Expand

Name	Schema
leader optional	integer (int32)
partition optional	integer (int32)
replicas optional	< Replica > array

3.2.17. Partitions
링크 복사

Expand

Name	Schema
partitions optional	< Partition > array

3.2.18. ProducerRecord
링크 복사

Expand

Name	Schema
headers optional	KafkaHeaderList
partition optional	integer (int32)

3.2.19. ProducerRecordList
링크 복사

Expand

Name	Schema
records optional	< ProducerRecord > array

3.2.20. ProducerRecordToPartition
링크 복사

Type : object

3.2.21. ProducerRecordToPartitionList
링크 복사

Expand

Name	Schema
records optional	< ProducerRecordToPartition > array

3.2.22. Replica
링크 복사

Expand

Name	Schema
broker optional	integer (int32)
in_sync optional	boolean
leader optional	boolean

3.2.23. SubscribedTopicList
링크 복사

Expand

Name	Schema
partitions optional	< AssignedTopicPartitions > array
topics optional	Topics

3.2.24. TopicMetadata
링크 복사

Expand

Name	Description	Schema
configs optional	Per-topic configuration overrides	< string, string > map
name optional	Name of the topic	string
partitions optional		< PartitionMetadata > array

3.2.25. Topics
링크 복사

Expand

Name	Description	Schema
topic_pattern optional	A regex topic pattern for matching multiple topics	string
topics optional		< string > array

3.3. Paths
링크 복사

3.3.1. GET /
링크 복사

3.3.1.1. Description
링크 복사

Retrieves information about the Kafka Bridge instance, in JSON format.

3.3.1.2. Responses
링크 복사

Expand

HTTP Code	Description	Schema
200	Information about Kafka Bridge instance.	BridgeInfo

3.3.1.3. Produces
링크 복사

application/json

3.3.1.4. Example HTTP response
링크 복사

3.3.1.4.1. Response 200
링크 복사

{
  "bridge_version" : "0.16.0"
}

{
  "bridge_version" : "0.16.0"
}

Copy to Clipboard

Toggle word wrap

3.3.2. POST /consumers/{groupid}
링크 복사

3.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.3.2.2. Parameters
링크 복사

Expand

Type	Name	Description	Schema
Path	groupid required	ID of the consumer group in which to create the consumer.	string
Body	body required	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.	Consumer

3.3.2.3. Responses
링크 복사

Expand

HTTP Code	Description	Schema
200	Consumer created successfully.	CreatedConsumer
409	A consumer instance with the specified name already exists in the Kafka Bridge.	Error
422	One or more consumer configuration options have invalid values.	Error

3.3.2.4. Consumes
링크 복사

application/vnd.kafka.v2+json

3.3.2.5. Produces
링크 복사

application/vnd.kafka.v2+json

3.3.2.6. Tags
링크 복사

Consumers

3.3.2.7. Example HTTP request
링크 복사

3.3.2.7.1. Request body
링크 복사

{
  "name" : "consumer1",
  "format" : "binary",
  "auto.offset.reset" : "earliest",
  "enable.auto.commit" : false,
  "fetch.min.bytes" : 512,
  "consumer.request.timeout.ms" : 30000,
  "isolation.level" : "read_committed"
}

{
  "name" : "consumer1",
  "format" : "binary",
  "auto.offset.reset" : "earliest",
  "enable.auto.commit" : false,
  "fetch.min.bytes" : 512,
  "consumer.request.timeout.ms" : 30000,
  "isolation.level" : "read_committed"
}

Copy to Clipboard

Toggle word wrap

3.3.2.8. Example HTTP response
링크 복사

3.3.2.8.1. Response 200
링크 복사

{
  "instance_id" : "consumer1",
  "base_uri" : "http://localhost:8080/consumers/my-group/instances/consumer1"
}

{
  "instance_id" : "consumer1",
  "base_uri" : "http://localhost:8080/consumers/my-group/instances/consumer1"
}

Copy to Clipboard

Toggle word wrap

3.3.2.8.2. Response 409
링크 복사

{
  "error_code" : 409,
  "message" : "A consumer instance with the specified name already exists in the Kafka Bridge."
}

{
  "error_code" : 409,
  "message" : "A consumer instance with the specified name already exists in the Kafka Bridge."
}

Copy to Clipboard

Toggle word wrap

3.3.2.8.3. Response 422
링크 복사

{
  "error_code" : 422,
  "message" : "One or more consumer configuration options have invalid values."
}

{
  "error_code" : 422,
  "message" : "One or more consumer configuration options have invalid values."
}

Copy to Clipboard

Toggle word wrap

3.3.3. DELETE /consumers/{groupid}/instances/{name}
링크 복사

3.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.3.2. Parameters
링크 복사

Expand

Type	Name	Description	Schema
Path	groupid required	ID of the consumer group to which the consumer belongs.	string
Path	name required	Name of the consumer to delete.	string

3.3.3.3. Responses
링크 복사

Expand

HTTP Code	Description	Schema
204	Consumer removed successfully.	No Content
404	The specified consumer instance was not found.	Error

3.3.3.4. Consumes
링크 복사

application/vnd.kafka.v2+json

3.3.3.5. Produces
링크 복사

application/vnd.kafka.v2+json

3.3.3.6. Tags
링크 복사

Consumers

3.3.3.7. Example HTTP response
링크 복사

3.3.3.7.1. Response 404
링크 복사

{
  "error_code" : 404,
  "message" : "The specified consumer instance was not found."
}

{
  "error_code" : 404,
  "message" : "The specified consumer instance was not found."
}

Copy to Clipboard

Toggle word wrap

3.3.4. POST /consumers/{groupid}/instances/{name}/assignments
링크 복사

3.3.4.1. Description
링크 복사

Assigns one or more topic partitions to a consumer.

3.3.4.2. Parameters
링크 복사

Expand

Type	Name	Description	Schema
Path	groupid required	ID of the consumer group to which the consumer belongs.	string
Path	name required	Name of the consumer to assign topic partitions to.	string
Body	body required	List of topic partitions to assign to the consumer.	Partitions

3.3.4.3. Responses
링크 복사

Expand

HTTP Code	Description	Schema
204	Partitions assigned successfully.	No Content
404	The specified consumer instance was not found.	Error
409	Subscriptions to topics, partitions, and patterns are mutually exclusive.	Error

3.3.4.4. Consumes
링크 복사

application/vnd.kafka.v2+json

3.3.4.5. Produces
링크 복사

application/vnd.kafka.v2+json

3.3.4.6. Tags
링크 복사

Consumers

3.3.4.7. Example HTTP request
링크 복사

3.3.4.7.1. Request body
링크 복사

{
  "partitions" : [ {
    "topic" : "topic",
    "partition" : 0
  }, {
    "topic" : "topic",
    "partition" : 1
  } ]
}

{
  "partitions" : [ {
    "topic" : "topic",
    "partition" : 0
  }, {
    "topic" : "topic",
    "partition" : 1
  } ]
}

Copy to Clipboard

Toggle word wrap

3.3.4.8. Example HTTP response
링크 복사

3.3.4.8.1. Response 404
링크 복사

{
  "error_code" : 404,
  "message" : "The specified consumer instance was not found."
}

{
  "error_code" : 404,
  "message" : "The specified consumer instance was not found."
}

Copy to Clipboard

Toggle word wrap

3.3.4.8.2. Response 409
링크 복사

{
  "error_code" : 409,
  "message" : "Subscriptions to topics, partitions, and patterns are mutually exclusive."
}

{
  "error_code" : 409,
  "message" : "Subscriptions to topics, partitions, and patterns are mutually exclusive."
}

Copy to Clipboard

Toggle word wrap

3.3.5. POST /consumers/{groupid}/instances/{name}/offsets
링크 복사

3.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.3.5.2. Parameters
링크 복사

Expand

Type	Name	Description	Schema
Path	groupid required	ID of the consumer group to which the consumer belongs.	string
Path	name required	Name of the consumer.	string
Body	body optional	List of consumer offsets to commit to the consumer offsets commit log. You can specify one or more topic partitions to commit offsets for.	OffsetCommitSeekList

3.3.5.3. Responses
링크 복사

Expand

HTTP Code	Description	Schema
204	Commit made successfully.	No Content
404	The specified consumer instance was not found.	Error

3.3.5.4. Consumes
링크 복사

application/vnd.kafka.v2+json

3.3.5.5. Produces
링크 복사

application/vnd.kafka.v2+json

3.3.5.6. Tags
링크 복사

Consumers

3.3.5.7. Example HTTP request
링크 복사

3.3.5.7.1. Request body
링크 복사

{
  "offsets" : [ {
    "topic" : "topic",
    "partition" : 0,
    "offset" : 15
  }, {
    "topic" : "topic",
    "partition" : 1,
    "offset" : 42
  } ]
}

{
  "offsets" : [ {
    "topic" : "topic",
    "partition" : 0,
    "offset" : 15
  }, {
    "topic" : "topic",
    "partition" : 1,
    "offset" : 42
  } ]
}

Copy to Clipboard

Toggle word wrap

3.3.5.8. Example HTTP response
링크 복사

3.3.5.8.1. Response 404
링크 복사

{
  "error_code" : 404,
  "message" : "The specified consumer instance was not found."
}

{
  "error_code" : 404,
  "message" : "The specified consumer instance was not found."
}

Copy to Clipboard

Toggle word wrap

3.3.6. POST /consumers/{groupid}/instances/{name}/positions
링크 복사

3.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.3.6.2. Parameters
링크 복사

Expand

Type	Name	Description	Schema
Path	groupid required	ID of the consumer group to which the consumer belongs.	string
Path	name required	Name of the subscribed consumer.	string
Body	body required	List of partition offsets from which the subscribed consumer will next fetch records.	OffsetCommitSeekList

3.3.6.3. Responses
링크 복사

Expand

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.	Error

3.3.6.4. Consumes
링크 복사

application/vnd.kafka.v2+json

3.3.6.5. Produces
링크 복사

application/vnd.kafka.v2+json

3.3.6.6. Tags
링크 복사

Consumers
Seek

3.3.6.7. Example HTTP request
링크 복사

3.3.6.7.1. Request body
링크 복사

{
  "offsets" : [ {
    "topic" : "topic",
    "partition" : 0,
    "offset" : 15
  }, {
    "topic" : "topic",
    "partition" : 1,
    "offset" : 42
  } ]
}

{
  "offsets" : [ {
    "topic" : "topic",
    "partition" : 0,
    "offset" : 15
  }, {
    "topic" : "topic",
    "partition" : 1,
    "offset" : 42
  } ]
}

Copy to Clipboard

Toggle word wrap

3.3.6.8. Example HTTP response
링크 복사

3.3.6.8.1. Response 404
링크 복사

{
  "error_code" : 404,
  "message" : "The specified consumer instance was not found."
}

{
  "error_code" : 404,
  "message" : "The specified consumer instance was not found."
}

Copy to Clipboard

Toggle word wrap

3.3.7. POST /consumers/{groupid}/instances/{name}/positions/beginning
링크 복사

3.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.3.7.2. Parameters
링크 복사

Expand

Type	Name	Description	Schema
Path	groupid required	ID of the consumer group to which the subscribed consumer belongs.	string
Path	name required	Name of the subscribed consumer.	string
Body	body required	List of topic partitions to which the consumer is subscribed. The consumer will seek the first offset in the specified partitions.	Partitions

3.3.7.3. Responses
링크 복사

Expand

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.	Error

3.3.7.4. Consumes
링크 복사

application/vnd.kafka.v2+json

3.3.7.5. Produces
링크 복사

application/vnd.kafka.v2+json

3.3.7.6. Tags
링크 복사

Consumers
Seek

3.3.7.7. Example HTTP request
링크 복사

3.3.7.7.1. Request body
링크 복사

{
  "partitions" : [ {
    "topic" : "topic",
    "partition" : 0
  }, {
    "topic" : "topic",
    "partition" : 1
  } ]
}

{
  "partitions" : [ {
    "topic" : "topic",
    "partition" : 0
  }, {
    "topic" : "topic",
    "partition" : 1
  } ]
}

Copy to Clipboard

Toggle word wrap

3.3.7.8. Example HTTP response
링크 복사

3.3.7.8.1. Response 404
링크 복사

{
  "error_code" : 404,
  "message" : "The specified consumer instance was not found."
}

{
  "error_code" : 404,
  "message" : "The specified consumer instance was not found."
}

Copy to Clipboard

Toggle word wrap

3.3.8. POST /consumers/{groupid}/instances/{name}/positions/end
링크 복사

3.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.3.8.2. Parameters
링크 복사

Expand

Type	Name	Description	Schema
Path	groupid required	ID of the consumer group to which the subscribed consumer belongs.	string
Path	name required	Name of the subscribed consumer.	string
Body	body optional	List of topic partitions to which the consumer is subscribed. The consumer will seek the last offset in the specified partitions.	Partitions

3.3.8.3. Responses
링크 복사

Expand

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.	Error

3.3.8.4. Consumes
링크 복사

application/vnd.kafka.v2+json

3.3.8.5. Produces
링크 복사

application/vnd.kafka.v2+json

3.3.8.6. Tags
링크 복사

Consumers
Seek

3.3.8.7. Example HTTP request
링크 복사

3.3.8.7.1. Request body
링크 복사

{
  "partitions" : [ {
    "topic" : "topic",
    "partition" : 0
  }, {
    "topic" : "topic",
    "partition" : 1
  } ]
}

{
  "partitions" : [ {
    "topic" : "topic",
    "partition" : 0
  }, {
    "topic" : "topic",
    "partition" : 1
  } ]
}

Copy to Clipboard

Toggle word wrap

3.3.8.8. Example HTTP response
링크 복사

3.3.8.8.1. Response 404
링크 복사

{
  "error_code" : 404,
  "message" : "The specified consumer instance was not found."
}

{
  "error_code" : 404,
  "message" : "The specified consumer instance was not found."
}

Copy to Clipboard

Toggle word wrap

3.3.9. GET /consumers/{groupid}/instances/{name}/records
링크 복사

3.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.3.9.2. Parameters
링크 복사

Expand

Type	Name	Description	Schema
Path	groupid required	ID of the consumer group to which the subscribed consumer belongs.	string
Path	name required	Name of the subscribed consumer to retrieve records from.	string
Query	max_bytes optional	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 optional	The maximum amount of time, in milliseconds, that the HTTP Bridge spends retrieving records before timing out the request.	integer

3.3.9.3. Responses
링크 복사

Expand

HTTP Code	Description	Schema
200	Poll request executed successfully.	ConsumerRecordList
404	The specified consumer instance was not found.	Error
406	The `format` used in the consumer creation request does not match the embedded format in the Accept header of this request or the bridge got a message from the topic which is not JSON encoded.	Error
422	Response exceeds the maximum number of bytes the consumer can receive	Error

3.3.9.4. Produces
링크 복사

application/vnd.kafka.json.v2+json
application/vnd.kafka.binary.v2+json
application/vnd.kafka.v2+json

3.3.9.5. Tags
링크 복사

Consumers

3.3.9.6. Example HTTP response
링크 복사

3.3.9.6.1. Response 200
링크 복사

[ {
  "topic" : "topic",
  "key" : "key1",
  "value" : {
    "foo" : "bar"
  },
  "partition" : 0,
  "offset" : 2
}, {
  "topic" : "topic",
  "key" : "key2",
  "value" : [ "foo2", "bar2" ],
  "partition" : 1,
  "offset" : 3
} ]

[ {
  "topic" : "topic",
  "key" : "key1",
  "value" : {
    "foo" : "bar"
  },
  "partition" : 0,
  "offset" : 2
}, {
  "topic" : "topic",
  "key" : "key2",
  "value" : [ "foo2", "bar2" ],
  "partition" : 1,
  "offset" : 3
} ]

Copy to Clipboard

Toggle word wrap

[
  {
    "topic": "test",
    "key": "a2V5",
    "value": "Y29uZmx1ZW50",
    "partition": 1,
    "offset": 100,
  },
  {
    "topic": "test",
    "key": "a2V5",
    "value": "a2Fma2E=",
    "partition": 2,
    "offset": 101,
  }
]

[
  {
    "topic": "test",
    "key": "a2V5",
    "value": "Y29uZmx1ZW50",
    "partition": 1,
    "offset": 100,
  },
  {
    "topic": "test",
    "key": "a2V5",
    "value": "a2Fma2E=",
    "partition": 2,
    "offset": 101,
  }
]

Copy to Clipboard

Toggle word wrap

3.3.9.6.2. Response 404
링크 복사

{
  "error_code" : 404,
  "message" : "The specified consumer instance was not found."
}

{
  "error_code" : 404,
  "message" : "The specified consumer instance was not found."
}

Copy to Clipboard

Toggle word wrap

3.3.9.6.3. Response 406
링크 복사

{
  "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."
}

{
  "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."
}

Copy to Clipboard

Toggle word wrap

3.3.9.6.4. Response 422
링크 복사

{
  "error_code" : 422,
  "message" : "Response exceeds the maximum number of bytes the consumer can receive"
}

{
  "error_code" : 422,
  "message" : "Response exceeds the maximum number of bytes the consumer can receive"
}

Copy to Clipboard

Toggle word wrap

3.3.10. POST /consumers/{groupid}/instances/{name}/subscription
링크 복사

3.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.3.10.2. Parameters
링크 복사

Expand

Type	Name	Description	Schema
Path	groupid required	ID of the consumer group to which the subscribed consumer belongs.	string
Path	name required	Name of the consumer to subscribe to topics.	string
Body	body required	List of topics to which the consumer will subscribe.	Topics

3.3.10.3. Responses
링크 복사

Expand

HTTP Code	Description	Schema
204	Consumer subscribed successfully.	No Content
404	The specified consumer instance was not found.	Error
409	Subscriptions to topics, partitions, and patterns are mutually exclusive.	Error
422	A list (of `Topics` type) or a `topic_pattern` must be specified.	Error

3.3.10.4. Consumes
링크 복사

application/vnd.kafka.v2+json

3.3.10.5. Produces
링크 복사

application/vnd.kafka.v2+json

3.3.10.6. Tags
링크 복사

Consumers

3.3.10.7. Example HTTP request
링크 복사

3.3.10.7.1. Request body
링크 복사

{
  "topics" : [ "topic1", "topic2" ]
}

{
  "topics" : [ "topic1", "topic2" ]
}

Copy to Clipboard

Toggle word wrap

3.3.10.8. Example HTTP response
링크 복사

3.3.10.8.1. Response 404
링크 복사

{
  "error_code" : 404,
  "message" : "The specified consumer instance was not found."
}

{
  "error_code" : 404,
  "message" : "The specified consumer instance was not found."
}

Copy to Clipboard

Toggle word wrap

3.3.10.8.2. Response 409
링크 복사

{
  "error_code" : 409,
  "message" : "Subscriptions to topics, partitions, and patterns are mutually exclusive."
}

{
  "error_code" : 409,
  "message" : "Subscriptions to topics, partitions, and patterns are mutually exclusive."
}

Copy to Clipboard

Toggle word wrap

3.3.10.8.3. Response 422
링크 복사

{
  "error_code" : 422,
  "message" : "A list (of Topics type) or a topic_pattern must be specified."
}

{
  "error_code" : 422,
  "message" : "A list (of Topics type) or a topic_pattern must be specified."
}

Copy to Clipboard

Toggle word wrap

3.3.11. GET /consumers/{groupid}/instances/{name}/subscription
링크 복사

3.3.11.1. Description
링크 복사

Retrieves a list of the topics to which the consumer is subscribed.

3.3.11.2. Parameters
링크 복사

Expand

Type	Name	Description	Schema
Path	groupid required	ID of the consumer group to which the subscribed consumer belongs.	string
Path	name required	Name of the subscribed consumer.	string

3.3.11.3. Responses
링크 복사

Expand

HTTP Code	Description	Schema
200	List of subscribed topics and partitions.	SubscribedTopicList
404	The specified consumer instance was not found.	Error

3.3.11.4. Produces
링크 복사

application/vnd.kafka.v2+json

3.3.11.5. Tags
링크 복사

Consumers

3.3.11.6. Example HTTP response
링크 복사

3.3.11.6.1. Response 200
링크 복사

{
  "topics" : [ "my-topic1", "my-topic2" ],
  "partitions" : [ {
    "my-topic1" : [ 1, 2, 3 ]
  }, {
    "my-topic2" : [ 1 ]
  } ]
}

{
  "topics" : [ "my-topic1", "my-topic2" ],
  "partitions" : [ {
    "my-topic1" : [ 1, 2, 3 ]
  }, {
    "my-topic2" : [ 1 ]
  } ]
}

Copy to Clipboard

Toggle word wrap

3.3.11.6.2. Response 404
링크 복사

{
  "error_code" : 404,
  "message" : "The specified consumer instance was not found."
}

{
  "error_code" : 404,
  "message" : "The specified consumer instance was not found."
}

Copy to Clipboard

Toggle word wrap

3.3.12. DELETE /consumers/{groupid}/instances/{name}/subscription
링크 복사

3.3.12.1. Description
링크 복사

Unsubscribes a consumer from all topics.

3.3.12.2. Parameters
링크 복사

Expand

Type	Name	Description	Schema
Path	groupid required	ID of the consumer group to which the subscribed consumer belongs.	string
Path	name required	Name of the consumer to unsubscribe from topics.	string

3.3.12.3. Responses
링크 복사

Expand

HTTP Code	Description	Schema
204	Consumer unsubscribed successfully.	No Content
404	The specified consumer instance was not found.	Error

3.3.12.4. Tags
링크 복사

Consumers

3.3.12.5. Example HTTP response
링크 복사

3.3.12.5.1. Response 404
링크 복사

{
  "error_code" : 404,
  "message" : "The specified consumer instance was not found."
}

{
  "error_code" : 404,
  "message" : "The specified consumer instance was not found."
}

Copy to Clipboard

Toggle word wrap

3.3.13. GET /healthy
링크 복사

3.3.13.1. Description
링크 복사

Check if the bridge is running. This does not necessarily imply that it is ready to accept requests.

3.3.13.2. Responses
링크 복사

Expand

HTTP Code	Description	Schema
200	The bridge is healthy	No Content

3.3.14. GET /openapi
링크 복사

3.3.14.1. Description
링크 복사

Retrieves the OpenAPI v2 specification in JSON format.

3.3.14.2. Responses
링크 복사

Expand

HTTP Code	Description	Schema
200	OpenAPI v2 specification in JSON format retrieved successfully.	string

3.3.14.3. Produces
링크 복사

application/json

3.3.15. GET /ready
링크 복사

3.3.15.1. Description
링크 복사

Check if the bridge is ready and can accept requests.

3.3.15.2. Responses
링크 복사

Expand

HTTP Code	Description	Schema
200	The bridge is ready	No Content

3.3.16. GET /topics
링크 복사

3.3.16.1. Description
링크 복사

Retrieves a list of all topics.

3.3.16.2. Responses
링크 복사

Expand

HTTP Code	Description	Schema
200	List of topics.	< string > array

3.3.16.3. Produces
링크 복사

application/vnd.kafka.v2+json

3.3.16.4. Tags
링크 복사

Topics

3.3.16.5. Example HTTP response
링크 복사

3.3.16.5.1. Response 200
링크 복사

[ "topic1", "topic2" ]

[ "topic1", "topic2" ]

Copy to Clipboard

Toggle word wrap

3.3.17. POST /topics/{topicname}
링크 복사

3.3.17.1. Description
링크 복사

Sends one or more records to a given topic, optionally specifying a partition, key, or both.

3.3.17.2. Parameters
링크 복사

Expand

Type	Name	Description	Schema
Path	topicname required	Name of the topic to send records to or retrieve metadata from.	string
Body	body required		ProducerRecordList

3.3.17.3. Responses
링크 복사

Expand

HTTP Code	Description	Schema
200	Records sent successfully.	OffsetRecordSentList
404	The specified topic was not found.	Error
422	The record list is not valid.	Error

3.3.17.4. Consumes
링크 복사

application/vnd.kafka.json.v2+json
application/vnd.kafka.binary.v2+json

3.3.17.5. Produces
링크 복사

application/vnd.kafka.v2+json

3.3.17.6. Tags
링크 복사

Producer
Topics

3.3.17.7. Example HTTP request
링크 복사

3.3.17.7.1. Request body
링크 복사

{
  "records" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "value" : "value2",
    "partition" : 1
  }, {
    "value" : "value3"
  } ]
}

{
  "records" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "value" : "value2",
    "partition" : 1
  }, {
    "value" : "value3"
  } ]
}

Copy to Clipboard

Toggle word wrap

3.3.17.8. Example HTTP response
링크 복사

3.3.17.8.1. Response 200
링크 복사

{
  "offsets" : [ {
    "partition" : 2,
    "offset" : 0
  }, {
    "partition" : 1,
    "offset" : 1
  }, {
    "partition" : 2,
    "offset" : 2
  } ]
}

{
  "offsets" : [ {
    "partition" : 2,
    "offset" : 0
  }, {
    "partition" : 1,
    "offset" : 1
  }, {
    "partition" : 2,
    "offset" : 2
  } ]
}

Copy to Clipboard

Toggle word wrap

3.3.17.8.2. Response 404
링크 복사

{
  "error_code" : 404,
  "message" : "The specified topic was not found."
}

{
  "error_code" : 404,
  "message" : "The specified topic was not found."
}

Copy to Clipboard

Toggle word wrap

3.3.17.8.3. Response 422
링크 복사

{
  "error_code" : 422,
  "message" : "The record list contains invalid records."
}

{
  "error_code" : 422,
  "message" : "The record list contains invalid records."
}

Copy to Clipboard

Toggle word wrap

3.3.18. GET /topics/{topicname}
링크 복사

3.3.18.1. Description
링크 복사

Retrieves the metadata about a given topic.

3.3.18.2. Parameters
링크 복사

Expand

Type	Name	Description	Schema
Path	topicname required	Name of the topic to send records to or retrieve metadata from.	string

3.3.18.3. Responses
링크 복사

Expand

HTTP Code	Description	Schema
200	Topic metadata	TopicMetadata

3.3.18.4. Produces
링크 복사

application/vnd.kafka.v2+json

3.3.18.5. Tags
링크 복사

Topics

3.3.18.6. Example HTTP response
링크 복사

3.3.18.6.1. Response 200
링크 복사

{
  "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
    } ]
  } ]
}

{
  "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
    } ]
  } ]
}

Copy to Clipboard

Toggle word wrap

3.3.19. GET /topics/{topicname}/partitions
링크 복사

3.3.19.1. Description
링크 복사

Retrieves a list of partitions for the topic.

3.3.19.2. Parameters
링크 복사

Expand

Type	Name	Description	Schema
Path	topicname required	Name of the topic to send records to or retrieve metadata from.	string

3.3.19.3. Responses
링크 복사

Expand

HTTP Code	Description	Schema
200	List of partitions	< PartitionMetadata > array
404	The specified topic was not found.	Error

3.3.19.4. Produces
링크 복사

application/vnd.kafka.v2+json

3.3.19.5. Tags
링크 복사

Topics

3.3.19.6. Example HTTP response
링크 복사

3.3.19.6.1. Response 200
링크 복사

[ {
  "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
  } ]
} ]

[ {
  "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
  } ]
} ]

Copy to Clipboard

Toggle word wrap

3.3.19.6.2. Response 404
링크 복사

{
  "error_code" : 404,
  "message" : "The specified topic was not found."
}

{
  "error_code" : 404,
  "message" : "The specified topic was not found."
}

Copy to Clipboard

Toggle word wrap

3.3.20. POST /topics/{topicname}/partitions/{partitionid}
링크 복사

3.3.20.1. Description
링크 복사

Sends one or more records to a given topic partition, optionally specifying a key.

3.3.20.2. Parameters
링크 복사

Expand

Type	Name	Description	Schema
Path	partitionid required	ID of the partition to send records to or retrieve metadata from.	integer
Path	topicname required	Name of the topic to send records to or retrieve metadata from.	string
Body	body required	List of records to send to a given topic partition, including a value (required) and a key (optional).	ProducerRecordToPartitionList

3.3.20.3. Responses
링크 복사

Expand

HTTP Code	Description	Schema
200	Records sent successfully.	OffsetRecordSentList
404	The specified topic partition was not found.	Error
422	The record is not valid.	Error

3.3.20.4. Consumes
링크 복사

application/vnd.kafka.json.v2+json
application/vnd.kafka.binary.v2+json

3.3.20.5. Produces
링크 복사

application/vnd.kafka.v2+json

3.3.20.6. Tags
링크 복사

Producer
Topics

3.3.20.7. Example HTTP request
링크 복사

3.3.20.7.1. Request body
링크 복사

{
  "records" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "value" : "value2"
  } ]
}

{
  "records" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "value" : "value2"
  } ]
}

Copy to Clipboard

Toggle word wrap

3.3.20.8. Example HTTP response
링크 복사

3.3.20.8.1. Response 200
링크 복사

{
  "offsets" : [ {
    "partition" : 2,
    "offset" : 0
  }, {
    "partition" : 1,
    "offset" : 1
  }, {
    "partition" : 2,
    "offset" : 2
  } ]
}

{
  "offsets" : [ {
    "partition" : 2,
    "offset" : 0
  }, {
    "partition" : 1,
    "offset" : 1
  }, {
    "partition" : 2,
    "offset" : 2
  } ]
}

Copy to Clipboard

Toggle word wrap

3.3.20.8.2. Response 404
링크 복사

{
  "error_code" : 404,
  "message" : "The specified topic partition was not found."
}

{
  "error_code" : 404,
  "message" : "The specified topic partition was not found."
}

Copy to Clipboard

Toggle word wrap

3.3.20.8.3. Response 422
링크 복사

{
  "error_code" : 422,
  "message" : "The record is not valid."
}

{
  "error_code" : 422,
  "message" : "The record is not valid."
}

Copy to Clipboard

Toggle word wrap

3.3.21. GET /topics/{topicname}/partitions/{partitionid}
링크 복사

3.3.21.1. Description
링크 복사

Retrieves partition metadata for the topic partition.

3.3.21.2. Parameters
링크 복사

Expand

Type	Name	Description	Schema
Path	partitionid required	ID of the partition to send records to or retrieve metadata from.	integer
Path	topicname required	Name of the topic to send records to or retrieve metadata from.	string

3.3.21.3. Responses
링크 복사

Expand

HTTP Code	Description	Schema
200	Partition metadata	PartitionMetadata
404	The specified topic partition was not found.	Error

3.3.21.4. Produces
링크 복사

application/vnd.kafka.v2+json

3.3.21.5. Tags
링크 복사

Topics

3.3.21.6. Example HTTP response
링크 복사

3.3.21.6.1. Response 200
링크 복사

{
  "partition" : 1,
  "leader" : 1,
  "replicas" : [ {
    "broker" : 1,
    "leader" : true,
    "in_sync" : true
  }, {
    "broker" : 2,
    "leader" : false,
    "in_sync" : true
  } ]
}

{
  "partition" : 1,
  "leader" : 1,
  "replicas" : [ {
    "broker" : 1,
    "leader" : true,
    "in_sync" : true
  }, {
    "broker" : 2,
    "leader" : false,
    "in_sync" : true
  } ]
}

Copy to Clipboard

Toggle word wrap

3.3.21.6.2. Response 404
링크 복사

{
  "error_code" : 404,
  "message" : "The specified topic partition was not found."
}

{
  "error_code" : 404,
  "message" : "The specified topic partition was not found."
}

Copy to Clipboard

Toggle word wrap

3.3.22. GET /topics/{topicname}/partitions/{partitionid}/offsets
링크 복사

3.3.22.1. Description
링크 복사

Retrieves a summary of the offsets for the topic partition.

3.3.22.2. Parameters
링크 복사

Expand

Type	Name	Description	Schema
Path	partitionid required	ID of the partition.	integer
Path	topicname required	Name of the topic containing the partition.	string

3.3.22.3. Responses
링크 복사

Expand

HTTP Code	Description	Schema
200	A summary of the offsets for the topic partition.	OffsetsSummary
404	The specified topic partition was not found.	Error

3.3.22.4. Produces
링크 복사

application/vnd.kafka.v2+json

3.3.22.5. Tags
링크 복사

Topics

3.3.22.6. Example HTTP response
링크 복사

3.3.22.6.1. Response 200
링크 복사

{
  "beginning_offset" : 10,
  "end_offset" : 50
}

{
  "beginning_offset" : 10,
  "end_offset" : 50
}

Copy to Clipboard

Toggle word wrap

3.3.22.6.2. Response 404
링크 복사

{
  "error_code" : 404,
  "message" : "The specified topic partition was not found."
}

{
  "error_code" : 404,
  "message" : "The specified topic partition was not found."
}

Copy to Clipboard

Toggle word wrap

맨 위로 이동

이 콘텐츠는 선택한 언어로 제공되지 않습니다.

Chapter 3. AMQ Streams Kafka Bridge API Reference

3.1. Overview링크 복사링크가 클립보드에 복사되었습니다!

3.1.1. Version information링크 복사링크가 클립보드에 복사되었습니다!

3.1.2. Tags링크 복사링크가 클립보드에 복사되었습니다!

3.1.3. Consumes링크 복사링크가 클립보드에 복사되었습니다!

3.1.4. Produces링크 복사링크가 클립보드에 복사되었습니다!

3.2. Definitions링크 복사링크가 클립보드에 복사되었습니다!

3.2.1. AssignedTopicPartitions링크 복사링크가 클립보드에 복사되었습니다!

3.2.2. BridgeInfo링크 복사링크가 클립보드에 복사되었습니다!

3.2.3. Consumer링크 복사링크가 클립보드에 복사되었습니다!

3.2.4. ConsumerRecord링크 복사링크가 클립보드에 복사되었습니다!

3.2.5. ConsumerRecordList링크 복사링크가 클립보드에 복사되었습니다!

3.2.6. CreatedConsumer링크 복사링크가 클립보드에 복사되었습니다!

3.2.7. Error링크 복사링크가 클립보드에 복사되었습니다!

3.2.8. KafkaHeader링크 복사링크가 클립보드에 복사되었습니다!

3.2.9. KafkaHeaderList링크 복사링크가 클립보드에 복사되었습니다!

3.2.10. OffsetCommitSeek링크 복사링크가 클립보드에 복사되었습니다!

3.2.11. OffsetCommitSeekList링크 복사링크가 클립보드에 복사되었습니다!

3.2.12. OffsetRecordSent링크 복사링크가 클립보드에 복사되었습니다!

3.2.13. OffsetRecordSentList링크 복사링크가 클립보드에 복사되었습니다!

3.2.14. OffsetsSummary링크 복사링크가 클립보드에 복사되었습니다!

3.2.15. Partition링크 복사링크가 클립보드에 복사되었습니다!

3.2.16. PartitionMetadata링크 복사링크가 클립보드에 복사되었습니다!

3.2.17. Partitions링크 복사링크가 클립보드에 복사되었습니다!

3.2.18. ProducerRecord링크 복사링크가 클립보드에 복사되었습니다!

3.2.19. ProducerRecordList링크 복사링크가 클립보드에 복사되었습니다!

3.2.20. ProducerRecordToPartition링크 복사링크가 클립보드에 복사되었습니다!

3.2.21. ProducerRecordToPartitionList링크 복사링크가 클립보드에 복사되었습니다!

3.2.22. Replica링크 복사링크가 클립보드에 복사되었습니다!

3.2.23. SubscribedTopicList링크 복사링크가 클립보드에 복사되었습니다!

3.2.24. TopicMetadata링크 복사링크가 클립보드에 복사되었습니다!

3.2.25. Topics링크 복사링크가 클립보드에 복사되었습니다!

3.3. Paths링크 복사링크가 클립보드에 복사되었습니다!

3.3.1. GET /링크 복사링크가 클립보드에 복사되었습니다!

3.3.1.1. Description링크 복사링크가 클립보드에 복사되었습니다!

3.3.1.2. Responses링크 복사링크가 클립보드에 복사되었습니다!

3.3.1.3. Produces링크 복사링크가 클립보드에 복사되었습니다!

3.3.1.4. Example HTTP response링크 복사링크가 클립보드에 복사되었습니다!

3.3.1.4.1. Response 200링크 복사링크가 클립보드에 복사되었습니다!

3.3.2. POST /consumers/{groupid}링크 복사링크가 클립보드에 복사되었습니다!

3.3.2.1. Description링크 복사링크가 클립보드에 복사되었습니다!

3.3.2.2. Parameters링크 복사링크가 클립보드에 복사되었습니다!

3.3.2.3. Responses링크 복사링크가 클립보드에 복사되었습니다!

3.3.2.4. Consumes링크 복사링크가 클립보드에 복사되었습니다!

3.3.2.5. Produces링크 복사링크가 클립보드에 복사되었습니다!

3.3.2.6. Tags링크 복사링크가 클립보드에 복사되었습니다!

3.3.2.7. Example HTTP request링크 복사링크가 클립보드에 복사되었습니다!

3.3.2.7.1. Request body링크 복사링크가 클립보드에 복사되었습니다!

3.3.2.8. Example HTTP response링크 복사링크가 클립보드에 복사되었습니다!

3.3.2.8.1. Response 200링크 복사링크가 클립보드에 복사되었습니다!

3.3.2.8.2. Response 409링크 복사링크가 클립보드에 복사되었습니다!

3.3.2.8.3. Response 422링크 복사링크가 클립보드에 복사되었습니다!

3.3.3. DELETE /consumers/{groupid}/instances/{name}링크 복사링크가 클립보드에 복사되었습니다!

3.3.3.1. Description링크 복사링크가 클립보드에 복사되었습니다!

3.3.3.2. Parameters링크 복사링크가 클립보드에 복사되었습니다!

3.3.3.3. Responses링크 복사링크가 클립보드에 복사되었습니다!

3.3.3.4. Consumes링크 복사링크가 클립보드에 복사되었습니다!

3.3.3.5. Produces링크 복사링크가 클립보드에 복사되었습니다!

3.3.3.6. Tags링크 복사링크가 클립보드에 복사되었습니다!

3.3.3.7. Example HTTP response링크 복사링크가 클립보드에 복사되었습니다!

3.3.3.7.1. Response 404링크 복사링크가 클립보드에 복사되었습니다!

3.3.4. POST /consumers/{groupid}/instances/{name}/assignments링크 복사링크가 클립보드에 복사되었습니다!

3.3.4.1. Description링크 복사링크가 클립보드에 복사되었습니다!

3.3.4.2. Parameters링크 복사링크가 클립보드에 복사되었습니다!

3.3.4.3. Responses링크 복사링크가 클립보드에 복사되었습니다!

3.3.4.4. Consumes링크 복사링크가 클립보드에 복사되었습니다!

3.3.4.5. Produces링크 복사링크가 클립보드에 복사되었습니다!

3.3.4.6. Tags링크 복사링크가 클립보드에 복사되었습니다!

3.3.4.7. Example HTTP request링크 복사링크가 클립보드에 복사되었습니다!

3.3.4.7.1. Request body링크 복사링크가 클립보드에 복사되었습니다!

3.3.4.8. Example HTTP response링크 복사링크가 클립보드에 복사되었습니다!

3.3.4.8.1. Response 404링크 복사링크가 클립보드에 복사되었습니다!

3.3.4.8.2. Response 409링크 복사링크가 클립보드에 복사되었습니다!

3.3.5. POST /consumers/{groupid}/instances/{name}/offsets링크 복사링크가 클립보드에 복사되었습니다!

3.3.5.1. Description링크 복사링크가 클립보드에 복사되었습니다!

3.3.5.2. Parameters링크 복사링크가 클립보드에 복사되었습니다!

3.3.5.3. Responses링크 복사링크가 클립보드에 복사되었습니다!

3.3.5.4. Consumes링크 복사링크가 클립보드에 복사되었습니다!

3.3.5.5. Produces링크 복사링크가 클립보드에 복사되었습니다!

3.1. Overview
링크 복사

3.1.1. Version information
링크 복사

3.1.2. Tags
링크 복사

3.1.3. Consumes
링크 복사

3.1.4. Produces
링크 복사

3.2. Definitions
링크 복사

3.2.1. AssignedTopicPartitions
링크 복사

3.2.2. BridgeInfo
링크 복사

3.2.3. Consumer
링크 복사

3.2.4. ConsumerRecord
링크 복사

3.2.5. ConsumerRecordList
링크 복사

3.2.6. CreatedConsumer
링크 복사

3.2.7. Error
링크 복사

3.2.8. KafkaHeader
링크 복사

3.2.9. KafkaHeaderList
링크 복사

3.2.10. OffsetCommitSeek
링크 복사

3.2.11. OffsetCommitSeekList
링크 복사

3.2.12. OffsetRecordSent
링크 복사

3.2.13. OffsetRecordSentList
링크 복사

3.2.14. OffsetsSummary
링크 복사

3.2.15. Partition
링크 복사

3.2.16. PartitionMetadata
링크 복사

3.2.17. Partitions
링크 복사

3.2.18. ProducerRecord
링크 복사

3.2.19. ProducerRecordList
링크 복사

3.2.20. ProducerRecordToPartition
링크 복사

3.2.21. ProducerRecordToPartitionList
링크 복사

3.2.22. Replica
링크 복사

3.2.23. SubscribedTopicList
링크 복사

3.2.24. TopicMetadata
링크 복사

3.2.25. Topics
링크 복사

3.3. Paths
링크 복사

3.3.1. GET /
링크 복사

3.3.1.1. Description
링크 복사

3.3.1.2. Responses
링크 복사

3.3.1.3. Produces
링크 복사

3.3.1.4. Example HTTP response
링크 복사

3.3.1.4.1. Response 200
링크 복사

3.3.2. POST /consumers/{groupid}
링크 복사

3.3.2.1. Description
링크 복사

3.3.2.2. Parameters
링크 복사

3.3.2.3. Responses
링크 복사

3.3.2.4. Consumes
링크 복사

3.3.2.5. Produces
링크 복사

3.3.2.6. Tags
링크 복사

3.3.2.7. Example HTTP request
링크 복사

3.3.2.7.1. Request body
링크 복사

3.3.2.8. Example HTTP response
링크 복사

3.3.2.8.1. Response 200
링크 복사

3.3.2.8.2. Response 409
링크 복사

3.3.2.8.3. Response 422
링크 복사

3.3.3. DELETE /consumers/{groupid}/instances/{name}
링크 복사

3.3.3.1. Description
링크 복사

3.3.3.2. Parameters
링크 복사

3.3.3.3. Responses
링크 복사

3.3.3.4. Consumes
링크 복사

3.3.3.5. Produces
링크 복사

3.3.3.6. Tags
링크 복사

3.3.3.7. Example HTTP response
링크 복사

3.3.3.7.1. Response 404
링크 복사

3.3.4. POST /consumers/{groupid}/instances/{name}/assignments
링크 복사

3.3.4.1. Description
링크 복사

3.3.4.2. Parameters
링크 복사

3.3.4.3. Responses
링크 복사

3.3.4.4. Consumes
링크 복사

3.3.4.5. Produces
링크 복사

3.3.4.6. Tags
링크 복사

3.3.4.7. Example HTTP request
링크 복사

3.3.4.7.1. Request body
링크 복사

3.3.4.8. Example HTTP response
링크 복사

3.3.4.8.1. Response 404
링크 복사

3.3.4.8.2. Response 409
링크 복사

3.3.5. POST /consumers/{groupid}/instances/{name}/offsets
링크 복사

3.3.5.1. Description
링크 복사

3.3.5.2. Parameters
링크 복사

3.3.5.3. Responses
링크 복사

3.3.5.4. Consumes
링크 복사

3.3.5.5. Produces
링크 복사

3.3.5.6. Tags
링크 복사

3.3.5.7. Example HTTP request
링크 복사