4.2. エンドポイント
4.2.1. Consumers リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.1. assign リンクのコピーリンクがクリップボードにコピーされました!
POST /consumers/{groupid}/instances/{name}/assignments
4.2.1.1.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
1 つ以上のトピックパーティションをコンシューマーに割り当てます。
4.2.1.1.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
groupid | コンシューマーが属するコンシューマーグループの ID。 | X | null | |
name | トピックパーティションを割り当てるコンシューマーの名前。 | X | null |
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
Partitions | コンシューマーに割り当てるトピックパーティションのリスト。「Partitions Partitions」 | X |
4.2.1.1.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
-
4.2.1.1.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- application/vnd.kafka.v2+json
4.2.1.1.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データ型 |
---|---|---|
204 | パーティションは正常に割り当てられました。 | <<>> |
404 | 指定されたコンシューマーインスタンスが見つかりませんでした。 | |
409 | トピック、パーティション、およびパターンへのサブスクリプションは相互に排他的です。 |
4.2.1.1.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.2. HTTP リクエストの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.2.1. リクエストの本文 リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.3. HTTP レスポンスの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.3.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."
}
4.2.1.3.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."
}
4.2.1.4. commit リンクのコピーリンクがクリップボードにコピーされました!
POST /consumers/{groupid}/instances/{name}/offsets
4.2.1.4.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
コンシューマーオフセットのリストをコミットします。コンシューマーによってフェッチされたすべてのレコードのオフセットをコミットするには、リクエストの本文を空のままにします。
4.2.1.4.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
groupid | コンシューマーが属するコンシューマーグループの ID。 | X | null | |
name | コンシューマーの名前。 | X | null |
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
OffsetCommitSeekList | コンシューマーオフセットコミットログにコミットするコンシューマーオフセットのリスト。オフセットをコミットする 1 つ以上のトピックパーティションを指定できます。「OffsetCommitSeekList OffsetCommitSeekList」 | - |
4.2.1.4.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
-
4.2.1.4.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- application/vnd.kafka.v2+json
4.2.1.4.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データ型 |
---|---|---|
204 | コミットは正常に行われました。 | <<>> |
404 | 指定されたコンシューマーインスタンスが見つかりませんでした。 |
4.2.1.4.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.5. HTTP リクエストの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.5.1. リクエストの本文 リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.6. HTTP レスポンスの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.6.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."
}
4.2.1.7. createConsumer リンクのコピーリンクがクリップボードにコピーされました!
POST /consumers/{groupid}
4.2.1.7.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
指定されたコンシューマーグループにコンシューマーインスタンスを作成します。任意で、コンシューマー名とサポートされている設定オプションを指定できます。これは、このコンシューマーインスタンスに対する後続のリクエストの URL 構築に使用する必要があるベース URI を返します。
4.2.1.7.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
groupid | コンシューマーを作成するコンシューマーグループの ID。 | X | null |
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
Consumer | コンシューマーの名前と設定。この名前は、コンシューマーグループの範囲内で一意です。名前が指定されていない場合は、ランダムに生成された名前が割り当てられます。すべてのパラメーターはオプションです。サポートされている設定オプションを次の例に示します。「Consumer Consumer」 | - |
4.2.1.7.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.7.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- application/vnd.kafka.v2+json
4.2.1.7.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データ型 |
---|---|---|
200 | コンシューマーは正常に作成されました。 | |
409 | 指定された名前のコンシューマーインスタンスは、Kafka Bridge にすでに存在します。 | |
422 | 1 つ以上のコンシューマー設定オプションに無効な値があります。 |
4.2.1.7.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.8. HTTP リクエストの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.8.1. リクエストの本文 リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.9. HTTP レスポンスの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.9.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"
}
4.2.1.9.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."
}
4.2.1.9.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."
}
4.2.1.10. deleteConsumer リンクのコピーリンクがクリップボードにコピーされました!
DELETE /consumers/{groupid}/instances/{name}
4.2.1.10.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
指定されたコンシューマーインスタンスを削除します。この操作のリクエストは、このコンシューマーの作成に使用された /consumers/{groupid}
への POST
リクエストからのレスポンスで返されたベース URL (ホストおよびポートを含む) を使用する必要があります。
4.2.1.10.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
groupid | コンシューマーが属するコンシューマーグループの ID。 | X | null | |
name | 削除するコンシューマーの名前。 | X | null |
4.2.1.10.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
-
4.2.1.10.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- application/vnd.kafka.v2+json
4.2.1.10.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データ型 |
---|---|---|
204 | コンシューマーは正常に削除されました。 | <<>> |
404 | 指定されたコンシューマーインスタンスが見つかりませんでした。 |
4.2.1.10.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.11. HTTP レスポンスの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.11.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."
}
4.2.1.12. listSubscriptions リンクのコピーリンクがクリップボードにコピーされました!
GET /consumers/{groupid}/instances/{name}/subscription
4.2.1.12.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
コンシューマーがサブスクライブしているトピックのリストを取得します。
4.2.1.12.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
groupid | サブスクライブされたコンシューマーが属するコンシューマーグループの ID。 | X | null | |
name | サブスクライブされたコンシューマーの名前。 | X | null |
4.2.1.12.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.12.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- application/vnd.kafka.v2+json
4.2.1.12.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データ型 |
---|---|---|
200 | サブスクライブされたトピックとパーティションのリスト。 | |
404 | 指定されたコンシューマーインスタンスが見つかりませんでした。 |
4.2.1.12.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.13. HTTP レスポンスの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.13.1. Response 200 リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.13.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."
}
4.2.1.14. poll リンクのコピーリンクがクリップボードにコピーされました!
GET /consumers/{groupid}/instances/{name}/records
4.2.1.14.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
メッセージ値、トピック、パーティションなど、サブスクライブされたコンシューマーのレコードを取得します。この操作のリクエストは、このコンシューマーの作成に使用された /consumers/{groupid}
への POST
リクエストからのレスポンスで返されたベース URL (ホストおよびポートを含む) を使用する必要があります。
4.2.1.14.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
groupid | サブスクライブされたコンシューマーが属するコンシューマーグループの ID。 | X | null | |
name | レコードを取得するサブスクライブされたコンシューマーの名前。 | X | null |
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
timeout | HTTP Bridge がリクエストをタイムアウトする前にレコードの取得に費やす最大時間 (ミリ秒単位)。 | - | null | |
max_bytes | レスポンスに含めることができるエンコードされていないキーと値の最大サイズ (バイト単位)。それ以外の場合は、コード 422 のエラーレスポンスが返されます。 | - | null |
4.2.1.14.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.14.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.2.1.14.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データ型 |
---|---|---|
200 | ポーリングリクエストは正常に実行されました。 | |
404 | 指定されたコンシューマーインスタンスが見つかりませんでした。 | |
406 | コンシューマー作成リクエストで使用された `format` が、このリクエストの Accept ヘッダーに埋め込まれたフォーマットと一致しないか、ブリッジが JSON 形式でエンコードされていないトピックからメッセージを受け取りました。 | |
422 | レスポンスにおいて、コンシューマーが受信できる最大バイト数を超えています |
4.2.1.14.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.15. HTTP レスポンスの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.15.1. Response 200 リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.15.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."
}
4.2.1.15.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."
}
4.2.1.15.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"
}
4.2.1.16. seek リンクのコピーリンクがクリップボードにコピーされました!
POST /consumers/{groupid}/instances/{name}/positions
4.2.1.16.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
サブスクライブされたコンシューマーが、次に特定のトピックパーティションからレコードのセットを取得するときに、特定のオフセットから複数のオフセットをフェッチするように設定します。これは、コンシューマーのデフォルトのフェッチ動作をオーバーライドします。1 つ以上のトピックパーティションを指定できます。
4.2.1.16.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
groupid | コンシューマーが属するコンシューマーグループの ID。 | X | null | |
name | サブスクライブされたコンシューマーの名前。 | X | null |
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
OffsetCommitSeekList | サブスクライブされたコンシューマーが次にレコードをフェッチするパーティションオフセットのリスト。「OffsetCommitSeekList OffsetCommitSeekList」 | X |
4.2.1.16.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
-
4.2.1.16.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- application/vnd.kafka.v2+json
4.2.1.16.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データ型 |
---|---|---|
204 | シークは正常に実行されました。 | <<>> |
404 | 指定されたコンシューマーインスタンスが見つからなかったか、指定されたコンシューマーインスタンスに指定されたパーティションの 1 つが割り当てられていませんでした。 |
4.2.1.16.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.17. HTTP リクエストの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.17.1. リクエストの本文 リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.18. HTTP レスポンスの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.18.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."
}
4.2.1.19. seekToBeginning リンクのコピーリンクがクリップボードにコピーされました!
POST /consumers/{groupid}/instances/{name}/positions/beginning
4.2.1.19.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
1 つ以上の指定されたトピックパーティションの最初のオフセットをシークする (そしてその後読み取る) ようにサブスクライブされたコンシューマーを設定します。
4.2.1.19.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
groupid | サブスクライブされたコンシューマーが属するコンシューマーグループの ID。 | X | null | |
name | サブスクライブされたコンシューマーの名前。 | X | null |
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
Partitions | コンシューマーがサブスクライブしているトピックパーティションのリスト。コンシューマーは、指定されたパーティションの最初のオフセットを探します。「Partitions Partitions」 | X |
4.2.1.19.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
-
4.2.1.19.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- application/vnd.kafka.v2+json
4.2.1.19.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データ型 |
---|---|---|
204 | 正常に実行されたものを最初にシークします。 | <<>> |
404 | 指定されたコンシューマーインスタンスが見つからなかったか、指定されたコンシューマーインスタンスに指定されたパーティションの 1 つが割り当てられていませんでした。 |
4.2.1.19.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.20. HTTP リクエストの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.20.1. リクエストの本文 リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.21. HTTP レスポンスの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.21.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."
}
4.2.1.22. seekToEnd リンクのコピーリンクがクリップボードにコピーされました!
POST /consumers/{groupid}/instances/{name}/positions/end
4.2.1.22.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
1 つ以上の指定されたトピックパーティションの終わりでオフセットをシークする (そしてその後読み取る) ようにサブスクライブされたコンシューマーを設定します。
4.2.1.22.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
groupid | サブスクライブされたコンシューマーが属するコンシューマーグループの ID。 | X | null | |
name | サブスクライブされたコンシューマーの名前。 | X | null |
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
Partitions | コンシューマーがサブスクライブしているトピックパーティションのリスト。コンシューマーは、指定されたパーティションの最後のオフセットをシークします。「Partitions Partitions」 | X |
4.2.1.22.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
-
4.2.1.22.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- application/vnd.kafka.v2+json
4.2.1.22.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データ型 |
---|---|---|
204 | 最後に正常に実行されたものをシークします。 | <<>> |
404 | 指定されたコンシューマーインスタンスが見つからなかったか、指定されたコンシューマーインスタンスに指定されたパーティションの 1 つが割り当てられていませんでした。 |
4.2.1.22.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.23. HTTP リクエストの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.23.1. リクエストの本文 リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.24. HTTP レスポンスの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.24.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."
}
4.2.1.25. subscribe リンクのコピーリンクがクリップボードにコピーされました!
POST /consumers/{groupid}/instances/{name}/subscription
4.2.1.25.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
コンシューマーを 1 つ以上のトピックにサブスクライブします。コンシューマーがサブスクライブするトピックを (トピック
タイプの) リスト、または topic_pattern
フィールドとして記述できます。各呼び出しは、サブスクライバーのサブスクリプションを置き換えます。
4.2.1.25.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
groupid | サブスクライブされたコンシューマーが属するコンシューマーグループの ID。 | X | null | |
name | トピックをサブスクライブするコンシューマーの名前。 | X | null |
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
トピック | コンシューマーがサブスクライブするトピックのリスト。「Topics Topics」 | X |
4.2.1.25.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
-
4.2.1.25.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- application/vnd.kafka.v2+json
4.2.1.25.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データ型 |
---|---|---|
204 | コンシューマーは正常にサブスクライブしました。 | <<>> |
404 | 指定されたコンシューマーインスタンスが見つかりませんでした。 | |
409 | トピック、パーティション、およびパターンへのサブスクリプションは相互に排他的です。 | |
422 | (`Topics` タイプの) リストまたは `topic_pattern` を指定する必要があります。 |
4.2.1.25.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.26. HTTP リクエストの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.26.1. リクエストの本文 リンクのコピーリンクがクリップボードにコピーされました!
{ "topics" : [ "topic1", "topic2" ] }
{
"topics" : [ "topic1", "topic2" ]
}
4.2.1.27. HTTP レスポンスの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.27.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."
}
4.2.1.27.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."
}
4.2.1.27.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."
}
4.2.1.28. unsubscribe リンクのコピーリンクがクリップボードにコピーされました!
DELETE /consumers/{groupid}/instances/{name}/subscription
4.2.1.28.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
すべてのトピックからコンシューマーの登録を解除します。
4.2.1.28.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
groupid | サブスクライブされたコンシューマーが属するコンシューマーグループの ID。 | X | null | |
name | トピックからサブスクライブを解除するコンシューマーの名前。 | X | null |
4.2.1.28.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
-
4.2.1.28.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- application/json
4.2.1.28.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データ型 |
---|---|---|
204 | コンシューマーは正常にサブスクライブを解除しました。 | <<>> |
404 | 指定されたコンシューマーインスタンスが見つかりませんでした。 |
4.2.1.28.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.29. HTTP レスポンスの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.1.29.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."
}
4.2.2. デフォルト リンクのコピーリンクがクリップボードにコピーされました!
4.2.2.1. healthy リンクのコピーリンクがクリップボードにコピーされました!
GET /healthy
4.2.2.1.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
ブリッジが実行しているかどうかを確認します。これは、必ずしもリクエストを受け入れる準備ができていることを意味するわけではありません。
4.2.2.1.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
4.2.2.1.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
-
4.2.2.1.4. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データ型 |
---|---|---|
204 | ブリッジは正常 | <<>> |
500 | ブリッジは正常ではない | <<>> |
4.2.2.1.5. サンプル リンクのコピーリンクがクリップボードにコピーされました!
4.2.2.2. info リンクのコピーリンクがクリップボードにコピーされました!
GET /
4.2.2.2.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
Kafka Bridge インスタンスに関する情報を JSON 形式で取得します。
4.2.2.2.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
4.2.2.2.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
4.2.2.2.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- application/json
4.2.2.2.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データ型 |
---|---|---|
200 | Kafka Bridge インスタンスに関する情報。 |
4.2.2.2.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
4.2.2.3. HTTP レスポンスの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.2.3.1. Response 200 リンクのコピーリンクがクリップボードにコピーされました!
{ "bridge_version" : 2.8 }
{
"bridge_version" : 2.8
}
4.2.2.4. metrics リンクのコピーリンクがクリップボードにコピーされました!
GET /メトリクス
4.2.2.4.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
Prometheus 形式でブリッジメトリクスを取得します。
4.2.2.4.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
4.2.2.4.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
String
4.2.2.4.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- text/plain
4.2.2.4.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データ型 |
---|---|---|
200 | Prometheus 形式のメトリクスが正常に取得されました。 | String |
4.2.2.4.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
4.2.2.5. openapi リンクのコピーリンクがクリップボードにコピーされました!
GET /openapi
4.2.2.5.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
OpenAPI v2 仕様を JSON 形式で取得します。
4.2.2.5.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
4.2.2.5.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
String
4.2.2.5.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- application/json
4.2.2.5.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データ型 |
---|---|---|
200 | JSON 形式の OpenAPI v2 仕様が正常に取得されました。 | String |
4.2.2.5.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
4.2.2.6. openapiv2 リンクのコピーリンクがクリップボードにコピーされました!
GET /openapi/v2
4.2.2.6.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
OpenAPI v2 仕様を JSON 形式で取得します。
4.2.2.6.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
4.2.2.6.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
String
4.2.2.6.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- application/json
4.2.2.6.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データ型 |
---|---|---|
200 | JSON 形式の OpenAPI v2 仕様が正常に取得されました。 | String |
4.2.2.6.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
4.2.2.7. openapiv3 リンクのコピーリンクがクリップボードにコピーされました!
GET /openapi/v3
4.2.2.7.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
OpenAPI v3 仕様を JSON 形式で取得します。
4.2.2.7.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
4.2.2.7.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
String
4.2.2.7.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- application/json
4.2.2.7.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データ型 |
---|---|---|
200 | JSON 形式の OpenAPI v3 仕様が正常に取得されました。 | String |
4.2.2.7.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
4.2.2.8. ready リンクのコピーリンクがクリップボードにコピーされました!
GET /ready
4.2.2.8.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
ブリッジの準備ができており、リクエストを受け入れることができるかどうかを確認してください。
4.2.2.8.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
4.2.2.8.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
-
4.2.2.8.4. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データ型 |
---|---|---|
204 | ブリッジの準備完了 | <<>> |
500 | ブリッジの準備未完了 | <<>> |
4.2.2.8.5. サンプル リンクのコピーリンクがクリップボードにコピーされました!
4.2.3. Producer リンクのコピーリンクがクリップボードにコピーされました!
4.2.3.1. send リンクのコピーリンクがクリップボードにコピーされました!
POST /topics/{topicname}
4.2.3.1.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
1 つ以上のレコードを特定のトピックに送信し、任意でパーティション、キー、またはその両方を指定します。
4.2.3.1.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
topicname | レコードの送信先またはメタデータの取得元のトピックの名前。 | X | null |
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
ProducerRecordList | X |
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
async | 送信操作の結果としてのメタデータを無視し、クライアントに返しません。指定されていない場合は false となり、メタデータが返されます。 | - | null |
4.2.3.1.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
4.2.3.1.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- application/vnd.kafka.v2+json
4.2.3.1.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データ型 |
---|---|---|
200 | レコードは正常に送信されました。 | |
404 | 指定されたトピックが見つかりませんでした。 | |
422 | レコードリストが無効です。 |
4.2.3.1.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
4.2.3.2. HTTP リクエストの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.3.2.1. リクエストの本文 リンクのコピーリンクがクリップボードにコピーされました!
4.2.3.3. HTTP レスポンスの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.3.3.1. Response 200 リンクのコピーリンクがクリップボードにコピーされました!
4.2.3.3.2. Response 404 リンクのコピーリンクがクリップボードにコピーされました!
{ "error_code" : 404, "message" : "The specified topic was not found." }
{
"error_code" : 404,
"message" : "The specified topic was not found."
}
4.2.3.3.3. Response 422 リンクのコピーリンクがクリップボードにコピーされました!
{ "error_code" : 422, "message" : "The record list contains invalid records." }
{
"error_code" : 422,
"message" : "The record list contains invalid records."
}
4.2.3.4. sendToPartition リンクのコピーリンクがクリップボードにコピーされました!
POST /topics/{topicname}/partitions/{partitionid}
4.2.3.4.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
任意でキーを指定して、1 つ以上のレコードを特定のトピックパーティションに送信します。
4.2.3.4.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
topicname | レコードの送信先またはメタデータの取得元のトピックの名前。 | X | null | |
partitionid | レコードを送信したり、メタデータを取得したりするパーティションの ID。 | X | null |
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
ProducerRecordToPartitionList | 値 (必須) とキー (任意) を含む、特定のトピックパーティションに送信するレコードのリスト。「ProducerRecordToPartitionList ProducerRecordToPartitionList」 | X |
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
async | メタデータを待機する代わりに、レコードの送信直後に返すかどうか。指定されている場合はオフセットは返されません。デフォルトは false です。 | - | null |
4.2.3.4.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
4.2.3.4.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- application/vnd.kafka.v2+json
4.2.3.4.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データ型 |
---|---|---|
200 | レコードは正常に送信されました。 | |
404 | 指定されたトピックパーティションが見つかりませんでした。 | |
422 | レコードが無効です。 |
4.2.3.4.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
4.2.3.5. HTTP リクエストの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.3.5.1. リクエストの本文 リンクのコピーリンクがクリップボードにコピーされました!
4.2.3.6. HTTP レスポンスの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.3.6.1. Response 200 リンクのコピーリンクがクリップボードにコピーされました!
4.2.3.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."
}
4.2.3.6.3. Response 422 リンクのコピーリンクがクリップボードにコピーされました!
{ "error_code" : 422, "message" : "The record is not valid." }
{
"error_code" : 422,
"message" : "The record is not valid."
}
4.2.4. Seek リンクのコピーリンクがクリップボードにコピーされました!
4.2.4.1. seek リンクのコピーリンクがクリップボードにコピーされました!
POST /consumers/{groupid}/instances/{name}/positions
4.2.4.1.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
サブスクライブされたコンシューマーが、次に特定のトピックパーティションからレコードのセットを取得するときに、特定のオフセットから複数のオフセットをフェッチするように設定します。これは、コンシューマーのデフォルトのフェッチ動作をオーバーライドします。1 つ以上のトピックパーティションを指定できます。
4.2.4.1.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
groupid | コンシューマーが属するコンシューマーグループの ID。 | X | null | |
name | サブスクライブされたコンシューマーの名前。 | X | null |
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
OffsetCommitSeekList | サブスクライブされたコンシューマーが次にレコードをフェッチするパーティションオフセットのリスト。「OffsetCommitSeekList OffsetCommitSeekList」 | X |
4.2.4.1.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
-
4.2.4.1.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- application/vnd.kafka.v2+json
4.2.4.1.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データ型 |
---|---|---|
204 | シークは正常に実行されました。 | <<>> |
404 | 指定されたコンシューマーインスタンスが見つからなかったか、指定されたコンシューマーインスタンスに指定されたパーティションの 1 つが割り当てられていませんでした。 |
4.2.4.1.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
4.2.4.2. HTTP リクエストの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.4.2.1. リクエストの本文 リンクのコピーリンクがクリップボードにコピーされました!
4.2.4.3. HTTP レスポンスの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.4.3.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."
}
4.2.4.4. seekToBeginning リンクのコピーリンクがクリップボードにコピーされました!
POST /consumers/{groupid}/instances/{name}/positions/beginning
4.2.4.4.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
1 つ以上の指定されたトピックパーティションの最初のオフセットをシークする (そしてその後読み取る) ようにサブスクライブされたコンシューマーを設定します。
4.2.4.4.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
groupid | サブスクライブされたコンシューマーが属するコンシューマーグループの ID。 | X | null | |
name | サブスクライブされたコンシューマーの名前。 | X | null |
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
Partitions | コンシューマーがサブスクライブしているトピックパーティションのリスト。コンシューマーは、指定されたパーティションの最初のオフセットを探します。「Partitions Partitions」 | X |
4.2.4.4.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
-
4.2.4.4.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- application/vnd.kafka.v2+json
4.2.4.4.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データ型 |
---|---|---|
204 | 正常に実行されたものを最初にシークします。 | <<>> |
404 | 指定されたコンシューマーインスタンスが見つからなかったか、指定されたコンシューマーインスタンスに指定されたパーティションの 1 つが割り当てられていませんでした。 |
4.2.4.4.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
4.2.4.5. HTTP リクエストの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.4.5.1. リクエストの本文 リンクのコピーリンクがクリップボードにコピーされました!
4.2.4.6. HTTP レスポンスの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.4.6.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."
}
4.2.4.7. seekToEnd リンクのコピーリンクがクリップボードにコピーされました!
POST /consumers/{groupid}/instances/{name}/positions/end
4.2.4.7.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
1 つ以上の指定されたトピックパーティションの終わりでオフセットをシークする (そしてその後読み取る) ようにサブスクライブされたコンシューマーを設定します。
4.2.4.7.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
groupid | サブスクライブされたコンシューマーが属するコンシューマーグループの ID。 | X | null | |
name | サブスクライブされたコンシューマーの名前。 | X | null |
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
Partitions | コンシューマーがサブスクライブしているトピックパーティションのリスト。コンシューマーは、指定されたパーティションの最後のオフセットをシークします。「Partitions Partitions」 | X |
4.2.4.7.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
-
4.2.4.7.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- application/vnd.kafka.v2+json
4.2.4.7.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データ型 |
---|---|---|
204 | 最後に正常に実行されたものをシークします。 | <<>> |
404 | 指定されたコンシューマーインスタンスが見つからなかったか、指定されたコンシューマーインスタンスに指定されたパーティションの 1 つが割り当てられていませんでした。 |
4.2.4.7.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
4.2.4.8. HTTP リクエストの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.4.8.1. リクエストの本文 リンクのコピーリンクがクリップボードにコピーされました!
4.2.4.9. HTTP レスポンスの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.4.9.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."
}
4.2.5. トピック リンクのコピーリンクがクリップボードにコピーされました!
4.2.5.1. getOffsets リンクのコピーリンクがクリップボードにコピーされました!
GET /topics/{topicname}/partitions/{partitionid}/offsets
4.2.5.1.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
トピックパーティションのオフセットの概要を取得します。
4.2.5.1.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
topicname | パーティションを含むトピックの名前。 | X | null | |
partitionid | パーティションの ID。 | X | null |
4.2.5.1.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
4.2.5.1.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- application/vnd.kafka.v2+json
4.2.5.1.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データ型 |
---|---|---|
200 | トピックパーティションのオフセットの概要。 | |
404 | 指定されたトピックパーティションが見つかりませんでした。 |
4.2.5.1.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
4.2.5.2. HTTP レスポンスの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.5.2.1. Response 200 リンクのコピーリンクがクリップボードにコピーされました!
{ "beginning_offset" : 10, "end_offset" : 50 }
{
"beginning_offset" : 10,
"end_offset" : 50
}
4.2.5.2.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."
}
4.2.5.3. getPartition リンクのコピーリンクがクリップボードにコピーされました!
GET /topics/{topicname}/partitions/{partitionid}
4.2.5.3.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
トピックパーティションのパーティションメタデータを取得します。
4.2.5.3.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
topicname | レコードの送信先またはメタデータの取得元のトピックの名前。 | X | null | |
partitionid | レコードを送信したり、メタデータを取得したりするパーティションの ID。 | X | null |
4.2.5.3.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
4.2.5.3.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- application/vnd.kafka.v2+json
4.2.5.3.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データ型 |
---|---|---|
200 | パーティションメタデータ | |
404 | 指定されたパーティションが見つかりませんでした。 |
4.2.5.3.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
4.2.5.4. HTTP レスポンスの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.5.4.1. Response 200 リンクのコピーリンクがクリップボードにコピーされました!
4.2.5.4.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."
}
4.2.5.5. getTopic リンクのコピーリンクがクリップボードにコピーされました!
GET /topics/{topicname}
4.2.5.5.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
特定のトピックに関するメタデータを取得します。
4.2.5.5.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
topicname | レコードの送信先またはメタデータの取得元のトピックの名前。 | X | null |
4.2.5.5.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
4.2.5.5.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- application/vnd.kafka.v2+json
4.2.5.5.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データ型 |
---|---|---|
200 | トピックのメタデータ | |
404 | 指定されたトピックが見つかりませんでした。 |
4.2.5.5.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
4.2.5.6. HTTP レスポンスの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.5.6.1. Response 200 リンクのコピーリンクがクリップボードにコピーされました!
4.2.5.7. listPartitions リンクのコピーリンクがクリップボードにコピーされました!
GET /topics/{topicname}/partitions
4.2.5.7.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
トピックのパーティションのリストを取得します。
4.2.5.7.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
topicname | レコードの送信先またはメタデータの取得元のトピックの名前。 | X | null |
4.2.5.7.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
4.2.5.7.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- application/vnd.kafka.v2+json
4.2.5.7.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データ型 |
---|---|---|
200 | パーティションのリスト。 | |
404 | 指定されたトピックが見つかりませんでした。 |
4.2.5.7.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
4.2.5.8. HTTP レスポンスの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.5.8.1. Response 200 リンクのコピーリンクがクリップボードにコピーされました!
4.2.5.8.2. Response 404 リンクのコピーリンクがクリップボードにコピーされました!
{ "error_code" : 404, "message" : "The specified topic was not found." }
{
"error_code" : 404,
"message" : "The specified topic was not found."
}
4.2.5.9. listTopics リンクのコピーリンクがクリップボードにコピーされました!
GET /topics
4.2.5.9.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
すべてのトピックのリストを取得します。
4.2.5.9.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
4.2.5.9.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
List
4.2.5.9.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- application/vnd.kafka.v2+json
4.2.5.9.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データ型 |
---|---|---|
200 | トピックのリスト。 | List[String] |
4.2.5.9.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
4.2.5.10. HTTP レスポンスの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.5.10.1. Response 200 リンクのコピーリンクがクリップボードにコピーされました!
[ "topic1", "topic2" ]
[ "topic1", "topic2" ]
4.2.5.11. send リンクのコピーリンクがクリップボードにコピーされました!
POST /topics/{topicname}
4.2.5.11.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
1 つ以上のレコードを特定のトピックに送信し、任意でパーティション、キー、またはその両方を指定します。
4.2.5.11.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
topicname | レコードの送信先またはメタデータの取得元のトピックの名前。 | X | null |
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
ProducerRecordList | X |
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
async | 送信操作の結果としてのメタデータを無視し、クライアントに返しません。指定されていない場合は false となり、メタデータが返されます。 | - | null |
4.2.5.11.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
4.2.5.11.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- application/vnd.kafka.v2+json
4.2.5.11.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データ型 |
---|---|---|
200 | レコードは正常に送信されました。 | |
404 | 指定されたトピックが見つかりませんでした。 | |
422 | レコードリストが無効です。 |
4.2.5.11.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
4.2.5.12. HTTP リクエストの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.5.12.1. リクエストの本文 リンクのコピーリンクがクリップボードにコピーされました!
4.2.5.13. HTTP レスポンスの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.5.13.1. Response 200 リンクのコピーリンクがクリップボードにコピーされました!
4.2.5.13.2. Response 404 リンクのコピーリンクがクリップボードにコピーされました!
{ "error_code" : 404, "message" : "The specified topic was not found." }
{
"error_code" : 404,
"message" : "The specified topic was not found."
}
4.2.5.13.3. Response 422 リンクのコピーリンクがクリップボードにコピーされました!
{ "error_code" : 422, "message" : "The record list contains invalid records." }
{
"error_code" : 422,
"message" : "The record list contains invalid records."
}
4.2.5.14. sendToPartition リンクのコピーリンクがクリップボードにコピーされました!
POST /topics/{topicname}/partitions/{partitionid}
4.2.5.14.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
任意でキーを指定して、1 つ以上のレコードを特定のトピックパーティションに送信します。
4.2.5.14.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
topicname | レコードの送信先またはメタデータの取得元のトピックの名前。 | X | null | |
partitionid | レコードを送信したり、メタデータを取得したりするパーティションの ID。 | X | null |
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
ProducerRecordToPartitionList | 値 (必須) とキー (任意) を含む、特定のトピックパーティションに送信するレコードのリスト。「ProducerRecordToPartitionList ProducerRecordToPartitionList」 | X |
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
async | メタデータを待機する代わりに、レコードの送信直後に返すかどうか。指定されている場合はオフセットは返されません。デフォルトは false です。 | - | null |
4.2.5.14.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
4.2.5.14.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- application/vnd.kafka.v2+json
4.2.5.14.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データ型 |
---|---|---|
200 | レコードは正常に送信されました。 | |
404 | 指定されたトピックパーティションが見つかりませんでした。 | |
422 | レコードが無効です。 |
4.2.5.14.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
4.2.5.15. HTTP リクエストの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.5.15.1. リクエストの本文 リンクのコピーリンクがクリップボードにコピーされました!
4.2.5.16. HTTP レスポンスの例 リンクのコピーリンクがクリップボードにコピーされました!
4.2.5.16.1. Response 200 リンクのコピーリンクがクリップボードにコピーされました!
4.2.5.16.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."
}
4.2.5.16.3. Response 422 リンクのコピーリンクがクリップボードにコピーされました!
{ "error_code" : 422, "message" : "The record is not valid." }
{
"error_code" : 422,
"message" : "The record is not valid."
}