Red Hat Summit4.2. Endpoints
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. Content Type
- application/vnd.kafka.v2+json
4.2.1.1.5. レスポンス
| コード | メッセージ | データ型 |
|---|---|---|
| 204 | パーティションは正常に割り当てられました。 | <<>> |
| 404 | 指定されたコンシューマーインスタンスが見つかりませんでした。 | |
| 409 | トピック、パーティション、およびパターンへのサブスクリプションは相互に排他的です。 |
4.2.1.1.6. Samples
4.2.1.2. commit
POST /consumers/{groupid}/instances/{name}/offsets
4.2.1.2.1. 説明
コンシューマーオフセットのリストをコミットします。コンシューマーによってフェッチされたすべてのレコードのオフセットをコミットするには、リクエストの本文を空のままにします。
4.2.1.2.2. パラメーター
| 名前 | 説明 | 必須 | デフォルト | パターン |
|---|---|---|---|---|
| groupid | コンシューマーが属するコンシューマーグループの ID。 | X | null | |
| name | コンシューマーの名前。 | X | null |
| 名前 | 説明 | 必須 | デフォルト | パターン |
|---|---|---|---|---|
| OffsetCommitSeekList | コンシューマーオフセットコミットログにコミットするコンシューマーオフセットのリスト。オフセットをコミットする 1 つ以上のトピックパーティションを指定できます。「OffsetCommitSeekList OffsetCommitSeekList」 | - |
4.2.1.2.3. 戻り値のタイプ
-
4.2.1.2.4. Content Type
- application/vnd.kafka.v2+json
4.2.1.2.5. レスポンス
| コード | メッセージ | データ型 |
|---|---|---|
| 204 | コミットは正常に行われました。 | <<>> |
| 404 | 指定されたコンシューマーインスタンスが見つかりませんでした。 |
4.2.1.2.6. Samples
4.2.1.3. createConsumer
POST /consumers/{groupid}
4.2.1.3.1. 説明
指定されたコンシューマーグループにコンシューマーインスタンスを作成します。任意で、コンシューマー名とサポートされている設定オプションを指定できます。これは、このコンシューマーインスタンスに対する後続のリクエストの URL 構築に使用する必要があるベース URI を返します。
4.2.1.3.2. パラメーター
| 名前 | 説明 | 必須 | デフォルト | パターン |
|---|---|---|---|---|
| groupid | コンシューマーを作成するコンシューマーグループの ID。 | X | null |
| 名前 | 説明 | 必須 | デフォルト | パターン |
|---|---|---|---|---|
| Consumer | コンシューマーの名前と設定。この名前は、コンシューマーグループの範囲内で一意です。名前が指定されていない場合は、ランダムに生成された名前が割り当てられます。すべてのパラメーターはオプションです。サポートされている設定オプションを次の例に示します。「Consumer Consumer」 | - |
4.2.1.3.3. 戻り値のタイプ
4.2.1.3.4. Content Type
- application/vnd.kafka.v2+json
4.2.1.3.5. レスポンス
| コード | メッセージ | データ型 |
|---|---|---|
| 200 | コンシューマーは正常に作成されました。 | |
| 409 | 指定された名前のコンシューマーインスタンスは、Kafka Bridge にすでに存在します。 | |
| 422 | 1 つ以上のコンシューマー設定オプションに無効な値があります。 |
4.2.1.3.6. Samples
4.2.1.4. deleteConsumer
DELETE /consumers/{groupid}/instances/{name}
4.2.1.4.1. 説明
指定されたコンシューマーインスタンスを削除します。この操作のリクエストは、このコンシューマーの作成に使用された /consumers/{groupid} への POST リクエストからのレスポンスで返されたベース URL (ホストおよびポートを含む) を使用する必要があります。
4.2.1.4.2. パラメーター
| 名前 | 説明 | 必須 | デフォルト | パターン |
|---|---|---|---|---|
| groupid | コンシューマーが属するコンシューマーグループの ID。 | X | null | |
| name | 削除するコンシューマーの名前。 | X | null |
4.2.1.4.3. 戻り値のタイプ
-
4.2.1.4.4. Content Type
- application/vnd.kafka.v2+json
4.2.1.4.5. レスポンス
| コード | メッセージ | データ型 |
|---|---|---|
| 204 | コンシューマーは正常に削除されました。 | <<>> |
| 404 | 指定されたコンシューマーインスタンスが見つかりませんでした。 |
4.2.1.4.6. Samples
4.2.1.5. listSubscriptions
GET /consumers/{groupid}/instances/{name}/subscription
4.2.1.5.1. 説明
コンシューマーがサブスクライブしているトピックのリストを取得します。
4.2.1.5.2. パラメーター
| 名前 | 説明 | 必須 | デフォルト | パターン |
|---|---|---|---|---|
| groupid | サブスクライブされたコンシューマーが属するコンシューマーグループの ID。 | X | null | |
| name | サブスクライブされたコンシューマーの名前。 | X | null |
4.2.1.5.3. 戻り値のタイプ
4.2.1.5.4. Content Type
- application/vnd.kafka.v2+json
4.2.1.5.5. レスポンス
| コード | メッセージ | データ型 |
|---|---|---|
| 200 | サブスクライブされたトピックとパーティションのリスト。 | |
| 404 | 指定されたコンシューマーインスタンスが見つかりませんでした。 |
4.2.1.5.6. Samples
4.2.1.6. poll
GET /consumers/{groupid}/instances/{name}/records
4.2.1.6.1. 説明
メッセージ値、トピック、パーティションなど、サブスクライブされたコンシューマーのレコードを取得します。この操作のリクエストは、このコンシューマーの作成に使用された /consumers/{groupid} への POST リクエストからのレスポンスで返されたベース URL (ホストおよびポートを含む) を使用する必要があります。
4.2.1.6.2. パラメーター
| 名前 | 説明 | 必須 | デフォルト | パターン |
|---|---|---|---|---|
| groupid | サブスクライブされたコンシューマーが属するコンシューマーグループの ID。 | X | null | |
| name | レコードを取得するサブスクライブされたコンシューマーの名前。 | X | null |
| 名前 | 説明 | 必須 | デフォルト | パターン |
|---|---|---|---|---|
| timeout | HTTP Bridge がリクエストをタイムアウトする前にレコードの取得に費やす最大時間 (ミリ秒単位)。 | - | null | |
| max_bytes | レスポンスに含めることができるエンコードされていないキーと値の最大サイズ (バイト単位)。それ以外の場合は、コード 422 のエラーレスポンスが返されます。 | - | null |
4.2.1.6.3. 戻り値のタイプ
4.2.1.6.4. Content Type
- 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.6.5. レスポンス
| コード | メッセージ | データ型 |
|---|---|---|
| 200 | ポーリングリクエストは正常に実行されました。 | |
| 404 | 指定されたコンシューマーインスタンスが見つかりませんでした。 | |
| 406 | コンシューマー作成リクエストで使用された `format` が、このリクエストの Accept ヘッダーに埋め込まれたフォーマットと一致しないか、ブリッジが JSON 形式でエンコードされていないトピックからメッセージを受け取りました。 | |
| 422 | レスポンスにおいて、コンシューマーが受信できる最大バイト数を超えています |
4.2.1.6.6. Samples
4.2.1.7. seek
POST /consumers/{groupid}/instances/{name}/positions
4.2.1.7.1. 説明
サブスクライブされたコンシューマーが、次に特定のトピックパーティションからレコードのセットを取得するときに、特定のオフセットから複数のオフセットをフェッチするように設定します。これは、コンシューマーのデフォルトのフェッチ動作をオーバーライドします。1 つ以上のトピックパーティションを指定できます。
4.2.1.7.2. パラメーター
| 名前 | 説明 | 必須 | デフォルト | パターン |
|---|---|---|---|---|
| groupid | コンシューマーが属するコンシューマーグループの ID。 | X | null | |
| name | サブスクライブされたコンシューマーの名前。 | X | null |
| 名前 | 説明 | 必須 | デフォルト | パターン |
|---|---|---|---|---|
| OffsetCommitSeekList | サブスクライブされたコンシューマーが次にレコードをフェッチするパーティションオフセットのリスト。「OffsetCommitSeekList OffsetCommitSeekList」 | X |
4.2.1.7.3. 戻り値のタイプ
-
4.2.1.7.4. Content Type
- application/vnd.kafka.v2+json
4.2.1.7.5. レスポンス
| コード | メッセージ | データ型 |
|---|---|---|
| 204 | シークは正常に実行されました。 | <<>> |
| 404 | 指定されたコンシューマーインスタンスが見つからなかったか、指定されたコンシューマーインスタンスに指定されたパーティションの 1 つが割り当てられていませんでした。 |
4.2.1.7.6. Samples
4.2.1.8. seekToBeginning
POST /consumers/{groupid}/instances/{name}/positions/beginning
4.2.1.8.1. 説明
1 つ以上の指定されたトピックパーティションの最初のオフセットをシークする (そしてその後読み取る) ようにサブスクライブされたコンシューマーを設定します。
4.2.1.8.2. パラメーター
| 名前 | 説明 | 必須 | デフォルト | パターン |
|---|---|---|---|---|
| groupid | サブスクライブされたコンシューマーが属するコンシューマーグループの ID。 | X | null | |
| name | サブスクライブされたコンシューマーの名前。 | X | null |
| 名前 | 説明 | 必須 | デフォルト | パターン |
|---|---|---|---|---|
| Partitions | コンシューマーがサブスクライブしているトピックパーティションのリスト。コンシューマーは、指定されたパーティションの最初のオフセットを探します。「Partitions Partitions」 | X |
4.2.1.8.3. 戻り値のタイプ
-
4.2.1.8.4. Content Type
- application/vnd.kafka.v2+json
4.2.1.8.5. レスポンス
| コード | メッセージ | データ型 |
|---|---|---|
| 204 | 正常に実行されたものを最初にシークします。 | <<>> |
| 404 | 指定されたコンシューマーインスタンスが見つからなかったか、指定されたコンシューマーインスタンスに指定されたパーティションの 1 つが割り当てられていませんでした。 |
4.2.1.8.6. Samples
4.2.1.9. seekToEnd
POST /consumers/{groupid}/instances/{name}/positions/end
4.2.1.9.1. 説明
1 つ以上の指定されたトピックパーティションの終わりでオフセットをシークする (そしてその後読み取る) ようにサブスクライブされたコンシューマーを設定します。
4.2.1.9.2. パラメーター
| 名前 | 説明 | 必須 | デフォルト | パターン |
|---|---|---|---|---|
| groupid | サブスクライブされたコンシューマーが属するコンシューマーグループの ID。 | X | null | |
| name | サブスクライブされたコンシューマーの名前。 | X | null |
| 名前 | 説明 | 必須 | デフォルト | パターン |
|---|---|---|---|---|
| Partitions | コンシューマーがサブスクライブしているトピックパーティションのリスト。コンシューマーは、指定されたパーティションの最後のオフセットをシークします。「Partitions Partitions」 | X |
4.2.1.9.3. 戻り値のタイプ
-
4.2.1.9.4. Content Type
- application/vnd.kafka.v2+json
4.2.1.9.5. レスポンス
| コード | メッセージ | データ型 |
|---|---|---|
| 204 | 最後に正常に実行されたものをシークします。 | <<>> |
| 404 | 指定されたコンシューマーインスタンスが見つからなかったか、指定されたコンシューマーインスタンスに指定されたパーティションの 1 つが割り当てられていませんでした。 |
4.2.1.9.6. Samples
4.2.1.10. subscribe
POST /consumers/{groupid}/instances/{name}/subscription
4.2.1.10.1. 説明
コンシューマーを 1 つ以上のトピックにサブスクライブします。コンシューマーがサブスクライブするトピックを (トピック タイプの) リスト、または topic_pattern フィールドとして記述できます。各呼び出しは、サブスクライバーのサブスクリプションを置き換えます。
4.2.1.10.2. パラメーター
| 名前 | 説明 | 必須 | デフォルト | パターン |
|---|---|---|---|---|
| groupid | サブスクライブされたコンシューマーが属するコンシューマーグループの ID。 | X | null | |
| name | トピックをサブスクライブするコンシューマーの名前。 | X | null |
| 名前 | 説明 | 必須 | デフォルト | パターン |
|---|---|---|---|---|
| Topics | コンシューマーがサブスクライブするトピックのリスト。「Topics」 | X |
4.2.1.10.3. 戻り値のタイプ
-
4.2.1.10.4. Content Type
- application/vnd.kafka.v2+json
4.2.1.10.5. レスポンス
| コード | メッセージ | データ型 |
|---|---|---|
| 204 | コンシューマーは正常にサブスクライブしました。 | <<>> |
| 404 | 指定されたコンシューマーインスタンスが見つかりませんでした。 | |
| 409 | トピック、パーティション、およびパターンへのサブスクリプションは相互に排他的です。 | |
| 422 | (`Topics` タイプの) リストまたは `topic_pattern` を指定する必要があります。 |
4.2.1.10.6. Samples
4.2.1.11. unsubscribe
DELETE /consumers/{groupid}/instances/{name}/subscription
4.2.1.11.1. 説明
すべてのトピックからコンシューマーの登録を解除します。
4.2.1.11.2. パラメーター
| 名前 | 説明 | 必須 | デフォルト | パターン |
|---|---|---|---|---|
| groupid | サブスクライブされたコンシューマーが属するコンシューマーグループの ID。 | X | null | |
| name | トピックからサブスクライブを解除するコンシューマーの名前。 | X | null |
4.2.1.11.3. 戻り値のタイプ
-
4.2.1.11.4. Content Type
- application/json
4.2.1.11.5. レスポンス
| コード | メッセージ | データ型 |
|---|---|---|
| 204 | コンシューマーは正常にサブスクライブを解除しました。 | <<>> |
| 404 | 指定されたコンシューマーインスタンスが見つかりませんでした。 |
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}