4.3. パス | Red Hat Product Documentation

4.3.1. GET /

4.3.1.1. 説明

Kafka Bridge インスタンスに関する情報を JSON 形式で取得します。

4.3.1.2. 応答

HTTP コード	説明	スキーマ
200	Kafka Bridge インスタンスに関する情報。	BridgeInfo

4.3.1.3. 生成されるアイテム

application/json

4.3.1.4. HTTP レスポンスの例

4.3.1.4.1. Response 200

{
  "bridge_version" : "0.16.0"
}

4.3.2. POST /consumers/{groupid}

4.3.2.1. 説明

指定されたコンシューマーグループにコンシューマーインスタンスを作成します。任意で、コンシューマー名とサポートされている設定オプションを指定できます。これは、このコンシューマーインスタンスに対する後続のリクエストの URL 構築に使用する必要があるベース URI を返します。

4.3.2.2. パラメーター

型	名前	説明	スキーマ
Path	groupid 必須	コンシューマーを作成するコンシューマーグループの ID。	文字列
Body	body 必須	コンシューマーの名前と設定。この名前は、コンシューマーグループの範囲内で一意です。名前が指定されていない場合は、ランダムに生成された名前が割り当てられます。すべてのパラメーターはオプションです。サポートされている設定オプションを次の例に示します。	コンシューマー

4.3.2.3. 応答

HTTP コード	説明	スキーマ
200	コンシューマーは正常に作成されました。	CreatedConsumer
409	指定された名前のコンシューマーインスタンスは、Kafka Bridge にすでに存在します。	エラー
422	1 つ以上のコンシューマー設定オプションに無効な値があります。	エラー

4.3.2.4. 消費されるアイテム

application/vnd.kafka.v2+json

4.3.2.5. 生成されるアイテム

application/vnd.kafka.v2+json

4.3.2.6. タグ

Consumers

4.3.2.7. HTTP リクエストの例

4.3.2.7.1. リクエストの本文

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

4.3.2.8. HTTP レスポンスの例

4.3.2.8.1. Response 200

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

4.3.2.8.2. Response 409

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

4.3.2.8.3. Response 422

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

4.3.3. DELETE /consumers/{groupid}/instances/{name}

4.3.3.1. 説明

指定されたコンシューマーインスタンスを削除します。この操作のリクエストは、このコンシューマーの作成に使用された /consumers/{groupid} への POST リクエストからのレスポンスで返されたベース URL (ホストおよびポートを含む) を使用する必要があります。

4.3.3.2. パラメーター

型	名前	説明	スキーマ
Path	groupid 必須	コンシューマーが属するコンシューマーグループの ID。	文字列
Path	name 必須	削除するコンシューマーの名前。	文字列

4.3.3.3. 応答

HTTP コード	説明	スキーマ
204	コンシューマーは正常に削除されました。	コンテンツなし
404	指定されたコンシューマーインスタンスが見つかりませんでした。	エラー

4.3.3.4. 消費されるアイテム

application/vnd.kafka.v2+json

4.3.3.5. 生成されるアイテム

application/vnd.kafka.v2+json

4.3.3.6. タグ

Consumers

4.3.3.7. HTTP レスポンスの例

4.3.3.7.1. Response 404

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

4.3.4. POST /consumers/{groupid}/instances/{name}/assignments

4.3.4.1. 説明

1 つ以上のトピックパーティションをコンシューマーに割り当てます。

4.3.4.2. パラメーター

型	名前	説明	スキーマ
Path	groupid 必須	コンシューマーが属するコンシューマーグループの ID。	文字列
Path	name 必須	トピックパーティションを割り当てるコンシューマーの名前。	文字列
Body	body 必須	コンシューマーに割り当てるトピックパーティションのリスト。	パーティション

4.3.4.3. 応答

HTTP コード	説明	スキーマ
204	パーティションは正常に割り当てられました。	コンテンツなし
404	指定されたコンシューマーインスタンスが見つかりませんでした。	エラー
409	トピック、パーティション、およびパターンへのサブスクリプションは相互に排他的です。	エラー

4.3.4.4. 消費されるアイテム

application/vnd.kafka.v2+json

4.3.4.5. 生成されるアイテム

application/vnd.kafka.v2+json

4.3.4.6. タグ

Consumers

4.3.4.7. HTTP リクエストの例

4.3.4.7.1. リクエストの本文

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

4.3.4.8. HTTP レスポンスの例

4.3.4.8.1. Response 404

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

4.3.4.8.2. Response 409

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

4.3.5. POST /consumers/{groupid}/instances/{name}/offsets

4.3.5.1. 説明

コンシューマーオフセットのリストをコミットします。コンシューマーによってフェッチされたすべてのレコードのオフセットをコミットするには、リクエストの本文を空のままにします。

4.3.5.2. パラメーター

型	名前	説明	スキーマ
Path	groupid 必須	コンシューマーが属するコンシューマーグループの ID。	文字列
Path	name 必須	コンシューマーの名前。	文字列
Body	body 任意	コンシューマーオフセットコミットログにコミットするコンシューマーオフセットのリスト。オフセットをコミットする 1 つ以上のトピックパーティションを指定できます。	OffsetCommitSeekList

4.3.5.3. 応答

HTTP コード	説明	スキーマ
204	コミットは正常に行われました。	コンテンツなし
404	指定されたコンシューマーインスタンスが見つかりませんでした。	エラー

4.3.5.4. 消費されるアイテム

application/vnd.kafka.v2+json

4.3.5.5. 生成されるアイテム

application/vnd.kafka.v2+json

4.3.5.6. タグ

Consumers

4.3.5.7. HTTP リクエストの例

4.3.5.7.1. リクエストの本文

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

4.3.5.8. HTTP レスポンスの例

4.3.5.8.1. Response 404

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

4.3.6. POST /consumers/{groupid}/instances/{name}/positions

4.3.6.1. 説明

サブスクライブされたコンシューマーが、次に特定のトピックパーティションからレコードのセットを取得するときに、特定のオフセットから複数のオフセットをフェッチするように設定します。これは、コンシューマーのデフォルトのフェッチ動作をオーバーライドします。1 つ以上のトピックパーティションを指定できます。

4.3.6.2. パラメーター

型	名前	説明	スキーマ
Path	groupid 必須	コンシューマーが属するコンシューマーグループの ID。	文字列
Path	name 必須	サブスクライブされたコンシューマーの名前。	文字列
Body	body 必須	サブスクライブされたコンシューマーが次にレコードをフェッチするパーティションオフセットのリスト。	OffsetCommitSeekList

4.3.6.3. 応答

HTTP コード	説明	スキーマ
204	シークは正常に実行されました。	コンテンツなし
404	指定されたコンシューマーインスタンスが見つからなかったか、指定されたコンシューマーインスタンスに指定されたパーティションの 1 つが割り当てられていませんでした。	エラー

4.3.6.4. 消費されるアイテム

application/vnd.kafka.v2+json

4.3.6.5. 生成されるアイテム

application/vnd.kafka.v2+json

4.3.6.6. タグ

Consumers
Seek

4.3.6.7. HTTP リクエストの例

4.3.6.7.1. リクエストの本文

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

4.3.6.8. HTTP レスポンスの例

4.3.6.8.1. Response 404

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

4.3.7. POST /consumers/{groupid}/instances/{name}/positions/beginning

4.3.7.1. 説明

1 つ以上の指定されたトピックパーティションの最初のオフセットをシークする (そしてその後読み取る) ようにサブスクライブされたコンシューマーを設定します。

4.3.7.2. パラメーター

型	名前	説明	スキーマ
Path	groupid 必須	サブスクライブされたコンシューマーが属するコンシューマーグループの ID。	文字列
Path	name 必須	サブスクライブされたコンシューマーの名前。	文字列
Body	body 必須	コンシューマーがサブスクライブしているトピックパーティションのリスト。コンシューマーは、指定されたパーティションの最初のオフセットを探します。	パーティション

4.3.7.3. 応答

HTTP コード	説明	スキーマ
204	正常に実行されたものを最初にシークします。	コンテンツなし
404	指定されたコンシューマーインスタンスが見つからなかったか、指定されたコンシューマーインスタンスに指定されたパーティションの 1 つが割り当てられていませんでした。	エラー

4.3.7.4. 消費されるアイテム

application/vnd.kafka.v2+json

4.3.7.5. 生成されるアイテム

application/vnd.kafka.v2+json

4.3.7.6. タグ

Consumers
Seek

4.3.7.7. HTTP リクエストの例

4.3.7.7.1. リクエストの本文

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

4.3.7.8. HTTP レスポンスの例

4.3.7.8.1. Response 404

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

4.3.8. POST /consumers/{groupid}/instances/{name}/positions/end

4.3.8.1. 説明

1 つ以上の指定されたトピックパーティションの終わりでオフセットをシークする (そしてその後読み取る) ようにサブスクライブされたコンシューマーを設定します。

4.3.8.2. パラメーター

型	名前	説明	スキーマ
Path	groupid 必須	サブスクライブされたコンシューマーが属するコンシューマーグループの ID。	文字列
Path	name 必須	サブスクライブされたコンシューマーの名前。	文字列
Body	body 任意	コンシューマーがサブスクライブしているトピックパーティションのリスト。コンシューマーは、指定されたパーティションの最後のオフセットをシークします。	パーティション

4.3.8.3. 応答

HTTP コード	説明	スキーマ
204	最後に正常に実行されたものをシークします。	コンテンツなし
404	指定されたコンシューマーインスタンスが見つからなかったか、指定されたコンシューマーインスタンスに指定されたパーティションの 1 つが割り当てられていませんでした。	エラー

4.3.8.4. 消費されるアイテム

application/vnd.kafka.v2+json

4.3.8.5. 生成されるアイテム

application/vnd.kafka.v2+json

4.3.8.6. タグ

Consumers
Seek

4.3.8.7. HTTP リクエストの例

4.3.8.7.1. リクエストの本文

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

4.3.8.8. HTTP レスポンスの例

4.3.8.8.1. Response 404

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

4.3.9. GET /consumers/{groupid}/instances/{name}/records

4.3.9.1. 説明

メッセージ値、トピック、パーティションなど、サブスクライブされたコンシューマーのレコードを取得します。この操作のリクエストは、このコンシューマーの作成に使用された /consumers/{groupid} への POST リクエストからのレスポンスで返されたベース URL (ホストおよびポートを含む) を使用する必要があります。

4.3.9.2. パラメーター

型	名前	説明	スキーマ
Path	groupid 必須	サブスクライブされたコンシューマーが属するコンシューマーグループの ID。	文字列
Path	name 必須	レコードを取得するサブスクライブされたコンシューマーの名前。	文字列
Query	max_bytes 任意	レスポンスに含めることができるエンコードされていないキーと値の最大サイズ (バイト単位)。それ以外の場合は、コード 422 のエラーレスポンスが返されます。	integer
Query	timeout 任意	HTTP Bridge がリクエストをタイムアウトする前にレコードの取得に費やす最大時間 (ミリ秒単位)。	integer

4.3.9.3. 応答

HTTP コード	説明	スキーマ
200	ポーリングリクエストは正常に実行されました。	ConsumerRecordList
404	指定されたコンシューマーインスタンスが見つかりませんでした。	エラー
406	コンシューマー作成リクエストで使用された `format` が、このリクエストの Accept ヘッダーに埋め込まれたフォーマットと一致しないか、ブリッジが JSON 形式でエンコードされていないトピックからメッセージを受け取りました。	エラー
422	レスポンスにおいて、コンシューマーが受信できる最大バイト数を超えています	エラー

4.3.9.4. 生成されるアイテム

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

4.3.9.5. タグ

Consumers

4.3.9.6. HTTP レスポンスの例

4.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": "test",
    "key": "a2V5",
    "value": "Y29uZmx1ZW50",
    "partition": 1,
    "offset": 100,
  },
  {
    "topic": "test",
    "key": "a2V5",
    "value": "a2Fma2E=",
    "partition": 2,
    "offset": 101,
  }
]

4.3.9.6.2. Response 404

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

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

4.3.9.6.4. Response 422

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

4.3.10. POST /consumers/{groupid}/instances/{name}/subscription

4.3.10.1. 説明

コンシューマーを 1 つ以上のトピックにサブスクライブします。コンシューマーがサブスクライブするトピックを (トピック タイプの) リスト、または topic_pattern フィールドとして記述できます。各呼び出しは、サブスクライバーのサブスクリプションを置き換えます。

4.3.10.2. パラメーター

型	名前	説明	スキーマ
Path	groupid 必須	サブスクライブされたコンシューマーが属するコンシューマーグループの ID。	文字列
Path	name 必須	トピックをサブスクライブするコンシューマーの名前。	文字列
Body	body 必須	コンシューマーがサブスクライブするトピックのリスト。	Topics

4.3.10.3. 応答

HTTP コード	説明	スキーマ
204	コンシューマーは正常にサブスクライブしました。	コンテンツなし
404	指定されたコンシューマーインスタンスが見つかりませんでした。	エラー
409	トピック、パーティション、およびパターンへのサブスクリプションは相互に排他的です。	エラー
422	(`Topics` タイプの) リストまたは `topic_pattern` を指定する必要があります。	エラー

4.3.10.4. 消費されるアイテム

application/vnd.kafka.v2+json

4.3.10.5. 生成されるアイテム

application/vnd.kafka.v2+json

4.3.10.6. タグ

Consumers

4.3.10.7. HTTP リクエストの例

4.3.10.7.1. リクエストの本文

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

4.3.10.8. HTTP レスポンスの例

4.3.10.8.1. Response 404

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

4.3.10.8.2. Response 409

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

4.3.10.8.3. Response 422

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

4.3.11. GET /consumers/{groupid}/instances/{name}/subscription

4.3.11.1. 説明

コンシューマーがサブスクライブしているトピックのリストを取得します。

4.3.11.2. パラメーター

型	名前	説明	スキーマ
Path	groupid 必須	サブスクライブされたコンシューマーが属するコンシューマーグループの ID。	文字列
Path	name 必須	サブスクライブされたコンシューマーの名前。	文字列

4.3.11.3. 応答

HTTP コード	説明	スキーマ
200	サブスクライブされたトピックとパーティションのリスト。	SubscribedTopicList
404	指定されたコンシューマーインスタンスが見つかりませんでした。	エラー

4.3.11.4. 生成されるアイテム

application/vnd.kafka.v2+json

4.3.11.5. タグ

Consumers

4.3.11.6. HTTP レスポンスの例

4.3.11.6.1. Response 200

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

4.3.11.6.2. Response 404

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

4.3.12. DELETE /consumers/{groupid}/instances/{name}/subscription

4.3.12.1. 説明

すべてのトピックからコンシューマーの登録を解除します。

4.3.12.2. パラメーター

型	名前	説明	スキーマ
Path	groupid 必須	サブスクライブされたコンシューマーが属するコンシューマーグループの ID。	文字列
Path	name 必須	トピックからサブスクライブを解除するコンシューマーの名前。	文字列

4.3.12.3. 応答

HTTP コード	説明	スキーマ
204	コンシューマーは正常にサブスクライブを解除しました。	コンテンツなし
404	指定されたコンシューマーインスタンスが見つかりませんでした。	エラー

4.3.12.4. タグ

Consumers

4.3.12.5. HTTP レスポンスの例

4.3.12.5.1. Response 404

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

4.3.13. GET /healthy

4.3.13.1. 説明

ブリッジが実行しているかどうかを確認します。これは、必ずしもリクエストを受け入れる準備ができていることを意味するわけではありません。

4.3.13.2. 応答

HTTP コード	説明	スキーマ
204	ブリッジは正常	コンテンツなし
500	ブリッジは正常ではない	コンテンツなし

4.3.14. GET /メトリクス

4.3.14.1. 説明

Prometheus 形式でブリッジメトリクスを取得します。

4.3.14.2. 応答

HTTP コード	説明	スキーマ
200	Prometheus 形式のメトリクスが正常に取得されました。	string

4.3.14.3. 生成されるアイテム

text/plain

4.3.15. GET /openapi

4.3.15.1. 説明

OpenAPI v2 仕様を JSON 形式で取得します。

4.3.15.2. 応答

HTTP コード	説明	スキーマ
204	JSON 形式の OpenAPI v2 仕様が正常に取得されました。	文字列

4.3.15.3. 生成されるアイテム

application/json

4.3.16. GET /ready

4.3.16.1. 説明

ブリッジの準備ができており、リクエストを受け入れることができるかどうかを確認してください。

4.3.16.2. 応答

HTTP コード	説明	スキーマ
204	ブリッジの準備完了	コンテンツなし
500	ブリッジの準備未完了	コンテンツなし

4.3.17. GET /topics

4.3.17.1. 説明

すべてのトピックのリストを取得します。

4.3.17.2. 応答

HTTP コード	説明	スキーマ
200	トピックのリスト。	< string > 配列

4.3.17.3. 生成されるアイテム

application/vnd.kafka.v2+json

4.3.17.4. タグ

Topics

4.3.17.5. HTTP レスポンスの例

4.3.17.5.1. Response 200

[ "topic1", "topic2" ]

4.3.18. POST /topics/{topicname}

4.3.18.1. 説明

1 つ以上のレコードを特定のトピックに送信し、任意でパーティション、キー、またはその両方を指定します。

4.3.18.2. パラメーター

型	名前	説明	スキーマ
Path	topicname 必須	レコードの送信先またはメタデータの取得元のトピックの名前。	文字列
Query	async 任意	メタデータを待機する代わりに、レコードの送信直後に返すかどうか。指定されている場合はオフセットは返されません。デフォルトは false です。	boolean
Body	body 必須		ProducerRecordList

4.3.18.3. 応答

HTTP コード	説明	スキーマ
200	レコードは正常に送信されました。	OffsetRecordSentList
404	指定されたトピックが見つかりませんでした。	エラー
422	レコードリストが無効です。	エラー

4.3.18.4. 消費されるアイテム

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

4.3.18.5. 生成されるアイテム

application/vnd.kafka.v2+json

4.3.18.6. タグ

producer
Topics

4.3.18.7. HTTP リクエストの例

4.3.18.7.1. リクエストの本文

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

4.3.18.8. HTTP レスポンスの例

4.3.18.8.1. Response 200

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

4.3.18.8.2. Response 404

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

4.3.18.8.3. Response 422

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

4.3.19. GET /topics/{topicname}

4.3.19.1. 説明

特定のトピックに関するメタデータを取得します。

4.3.19.2. パラメーター

型	名前	説明	スキーマ
Path	topicname 必須	レコードの送信先またはメタデータの取得元のトピックの名前。	文字列

4.3.19.3. 応答

HTTP コード	説明	スキーマ
200	トピックのメタデータ	TopicMetadata

4.3.19.4. 生成されるアイテム

application/vnd.kafka.v2+json

4.3.19.5. タグ

Topics

4.3.19.6. HTTP レスポンスの例

4.3.19.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
    } ]
  } ]
}

4.3.20. GET /topics/{topicname}/partitions

4.3.20.1. 説明

トピックのパーティションのリストを取得します。

4.3.20.2. パラメーター

型	名前	説明	スキーマ
Path	topicname 必須	レコードの送信先またはメタデータの取得元のトピックの名前。	文字列

4.3.20.3. 応答

HTTP コード	説明	スキーマ
200	パーティションのリスト	< PartitionMetadata > 配列
404	指定されたトピックが見つかりませんでした。	エラー

4.3.20.4. 生成されるアイテム

application/vnd.kafka.v2+json

4.3.20.5. タグ

Topics

4.3.20.6. HTTP レスポンスの例

4.3.20.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
  } ]
} ]

4.3.20.6.2. Response 404

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

4.3.21. POST /topics/{topicname}/partitions/{partitionid}

4.3.21.1. 説明

任意でキーを指定して、1 つ以上のレコードを特定のトピックパーティションに送信します。

4.3.21.2. パラメーター

型	名前	説明	スキーマ
Path	partitionid 必須	レコードを送信したり、メタデータを取得したりするパーティションの ID。	integer
Path	topicname 必須	レコードの送信先またはメタデータの取得元のトピックの名前。	文字列
Query	async 任意	メタデータを待機する代わりに、レコードの送信直後に返すかどうか。指定されている場合はオフセットは返されません。デフォルトは false です。	boolean
Body	body 必須	値 (必須) とキー (任意) を含む、特定のトピックパーティションに送信するレコードのリスト。	ProducerRecordToPartitionList

4.3.21.3. 応答

HTTP コード	説明	スキーマ
200	レコードは正常に送信されました。	OffsetRecordSentList
404	指定されたトピックパーティションが見つかりませんでした。	エラー
422	レコードが無効です。	エラー

4.3.21.4. 消費されるアイテム

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

4.3.21.5. 生成されるアイテム

application/vnd.kafka.v2+json

4.3.21.6. タグ

producer
Topics

4.3.21.7. HTTP リクエストの例

4.3.21.7.1. リクエストの本文

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

4.3.21.8. HTTP レスポンスの例

4.3.21.8.1. Response 200

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

4.3.21.8.2. Response 404

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

4.3.21.8.3. Response 422

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

4.3.22. GET /topics/{topicname}/partitions/{partitionid}

4.3.22.1. 説明

トピックパーティションのパーティションメタデータを取得します。

4.3.22.2. パラメーター

型	名前	説明	スキーマ
Path	partitionid 必須	レコードを送信したり、メタデータを取得したりするパーティションの ID。	integer
Path	topicname 必須	レコードの送信先またはメタデータの取得元のトピックの名前。	文字列

4.3.22.3. 応答

HTTP コード	説明	スキーマ
200	パーティションメタデータ	PartitionMetadata
404	指定されたトピックパーティションが見つかりませんでした。	エラー

4.3.22.4. 生成されるアイテム

application/vnd.kafka.v2+json

4.3.22.5. タグ

Topics

4.3.22.6. HTTP レスポンスの例

4.3.22.6.1. Response 200

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

4.3.22.6.2. Response 404

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

4.3.23. GET /topics/{topicname}/partitions/{partitionid}/offsets

4.3.23.1. 説明

トピックパーティションのオフセットの概要を取得します。

4.3.23.2. パラメーター

型	名前	説明	スキーマ
Path	partitionid 必須	パーティションの ID。	integer
Path	topicname 必須	パーティションを含むトピックの名前。	文字列

4.3.23.3. 応答

HTTP コード	説明	スキーマ
200	トピックパーティションのオフセットの要約。	OffsetsSummary
404	指定されたトピックパーティションが見つかりませんでした。	エラー

4.3.23.4. 生成されるアイテム

application/vnd.kafka.v2+json

4.3.23.5. タグ

Topics

4.3.23.6. HTTP レスポンスの例

4.3.23.6.1. Response 200

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

4.3.23.6.2. Response 404

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