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. パラメーター
Expand
表4.1 パスパラメーター
名前説明必須デフォルトパターン

groupid

コンシューマーが属するコンシューマーグループの ID。

X

null

 

name

トピックパーティションを割り当てるコンシューマーの名前。

X

null

 
Expand
表4.2 本文パラメーター
名前説明必須デフォルトパターン

Partitions

コンシューマーに割り当てるトピックパーティションのリスト。Partitions Partitions」

X

  
4.2.1.1.3. 戻り値のタイプ

-

4.2.1.1.4. コンテンツタイプ
  • application/vnd.kafka.v2+json
4.2.1.1.5. レスポンス
Expand
表4.3 HTTP レスポンスコード
コードメッセージデータ型

204

パーティションは正常に割り当てられました。

<<>>

404

指定されたコンシューマーインスタンスが見つかりませんでした。

Error Error」

409

トピック、パーティション、およびパターンへのサブスクリプションは相互に排他的です。

Error Error」

4.2.1.1.6. サンプル

4.2.1.2. HTTP リクエストの例

4.2.1.2.1. リクエストの本文
{
  "partitions" : [ {
    "topic" : "topic",
    "partition" : 0
  }, {
    "topic" : "topic",
    "partition" : 1
  } ]
}
Copy to Clipboard Toggle word wrap

4.2.1.3. HTTP レスポンスの例

4.2.1.3.1. Response 404
{
  "error_code" : 404,
  "message" : "The specified consumer instance was not found."
}
Copy to Clipboard Toggle word wrap
4.2.1.3.2. Response 409
{
  "error_code" : 409,
  "message" : "Subscriptions to topics, partitions, and patterns are mutually exclusive."
}
Copy to Clipboard Toggle word wrap

4.2.1.4. commit

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

4.2.1.4.1. 説明

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

4.2.1.4.2. パラメーター
Expand
表4.4 パスパラメーター
名前説明必須デフォルトパターン

groupid

コンシューマーが属するコンシューマーグループの ID。

X

null

 

name

コンシューマーの名前。

X

null

 
Expand
表4.5 本文パラメーター
名前説明必須デフォルトパターン

OffsetCommitSeekList

コンシューマーオフセットコミットログにコミットするコンシューマーオフセットのリスト。オフセットをコミットする 1 つ以上のトピックパーティションを指定できます。OffsetCommitSeekList OffsetCommitSeekList」

-

  
4.2.1.4.3. 戻り値のタイプ

-

4.2.1.4.4. コンテンツタイプ
  • application/vnd.kafka.v2+json
4.2.1.4.5. レスポンス
Expand
表4.6 HTTP レスポンスコード
コードメッセージデータ型

204

コミットは正常に行われました。

<<>>

404

指定されたコンシューマーインスタンスが見つかりませんでした。

Error Error」

4.2.1.4.6. サンプル

4.2.1.5. HTTP リクエストの例

4.2.1.5.1. リクエストの本文
{
  "offsets" : [ {
    "topic" : "topic",
    "partition" : 0,
    "offset" : 15
  }, {
    "topic" : "topic",
    "partition" : 1,
    "offset" : 42
  } ]
}
Copy to Clipboard Toggle word wrap

4.2.1.6. HTTP レスポンスの例

4.2.1.6.1. Response 404
{
  "error_code" : 404,
  "message" : "The specified consumer instance was not found."
}
Copy to Clipboard Toggle word wrap

4.2.1.7. createConsumer

POST /consumers/{groupid}

4.2.1.7.1. 説明

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

4.2.1.7.2. パラメーター
Expand
表4.7 パスパラメーター
名前説明必須デフォルトパターン

groupid

コンシューマーを作成するコンシューマーグループの ID。

X

null

 
Expand
表4.8 本文パラメーター
名前説明必須デフォルトパターン

Consumer

コンシューマーの名前と設定。この名前は、コンシューマーグループの範囲内で一意です。名前が指定されていない場合は、ランダムに生成された名前が割り当てられます。すべてのパラメーターはオプションです。サポートされている設定オプションを次の例に示します。Consumer Consumer」

-

  
4.2.1.7.3. 戻り値のタイプ

CreatedConsumer CreatedConsumer」

4.2.1.7.4. コンテンツタイプ
  • application/vnd.kafka.v2+json
4.2.1.7.5. レスポンス
Expand
表4.9 HTTP レスポンスコード
コードメッセージデータ型

200

コンシューマーは正常に作成されました。

CreatedConsumer CreatedConsumer」

409

指定された名前のコンシューマーインスタンスは、Kafka Bridge にすでに存在します。

Error Error」

422

1 つ以上のコンシューマー設定オプションに無効な値があります。

Error Error」

4.2.1.7.6. サンプル

4.2.1.8. HTTP リクエストの例

4.2.1.8.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"
}
Copy to Clipboard Toggle word wrap

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"
}
Copy to Clipboard Toggle word wrap
4.2.1.9.2. Response 409
{
  "error_code" : 409,
  "message" : "A consumer instance with the specified name already exists in the Kafka Bridge."
}
Copy to Clipboard Toggle word wrap
4.2.1.9.3. Response 422
{
  "error_code" : 422,
  "message" : "One or more consumer configuration options have invalid values."
}
Copy to Clipboard Toggle word wrap

4.2.1.10. deleteConsumer

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

4.2.1.10.1. 説明

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

4.2.1.10.2. パラメーター
Expand
表4.10 パスパラメーター
名前説明必須デフォルトパターン

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. レスポンス
Expand
表4.11 HTTP レスポンスコード
コードメッセージデータ型

204

コンシューマーは正常に削除されました。

<<>>

404

指定されたコンシューマーインスタンスが見つかりませんでした。

Error Error」

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."
}
Copy to Clipboard Toggle word wrap

4.2.1.12. listSubscriptions

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

4.2.1.12.1. 説明

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

4.2.1.12.2. パラメーター
Expand
表4.12 パスパラメーター
名前説明必須デフォルトパターン

groupid

サブスクライブされたコンシューマーが属するコンシューマーグループの ID。

X

null

 

name

サブスクライブされたコンシューマーの名前。

X

null

 
4.2.1.12.3. 戻り値のタイプ

SubscribedTopicList SubscribedTopicList」

4.2.1.12.4. コンテンツタイプ
  • application/vnd.kafka.v2+json
4.2.1.12.5. レスポンス
Expand
表4.13 HTTP レスポンスコード
コードメッセージデータ型

200

サブスクライブされたトピックとパーティションのリスト。

SubscribedTopicList SubscribedTopicList」

404

指定されたコンシューマーインスタンスが見つかりませんでした。

Error Error」

4.2.1.12.6. サンプル

4.2.1.13. HTTP レスポンスの例

4.2.1.13.1. Response 200
{
  "topics" : [ "my-topic1", "my-topic2" ],
  "partitions" : [ {
    "my-topic1" : [ 1, 2, 3 ]
  }, {
    "my-topic2" : [ 1 ]
  } ]
}
Copy to Clipboard Toggle word wrap
4.2.1.13.2. Response 404
{
  "error_code" : 404,
  "message" : "The specified consumer instance was not found."
}
Copy to Clipboard Toggle word wrap

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. パラメーター
Expand
表4.14 パスパラメーター
名前説明必須デフォルトパターン

groupid

サブスクライブされたコンシューマーが属するコンシューマーグループの ID。

X

null

 

name

レコードを取得するサブスクライブされたコンシューマーの名前。

X

null

 
Expand
表4.15 クエリーパラメーター
名前説明必須デフォルトパターン

timeout

HTTP Bridge がリクエストをタイムアウトする前にレコードの取得に費やす最大時間 (ミリ秒単位)。

-

null

 

max_bytes

レスポンスに含めることができるエンコードされていないキーと値の最大サイズ (バイト単位)。それ以外の場合は、コード 422 のエラーレスポンスが返されます。

-

null

 
4.2.1.14.3. 戻り値のタイプ

array[ConsumerRecord ConsumerRecord」]

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. レスポンス
Expand
表4.16 HTTP レスポンスコード
コードメッセージデータ型

200

ポーリングリクエストは正常に実行されました。

List[ConsumerRecord ConsumerRecord」]

404

指定されたコンシューマーインスタンスが見つかりませんでした。

Error Error」

406

コンシューマー作成リクエストで使用された `format` が、このリクエストの Accept ヘッダーに埋め込まれたフォーマットと一致しないか、ブリッジが JSON 形式でエンコードされていないトピックからメッセージを受け取りました。

Error Error」

422

レスポンスにおいて、コンシューマーが受信できる最大バイト数を超えています

Error Error」

4.2.1.14.6. サンプル

4.2.1.15. HTTP レスポンスの例

4.2.1.15.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
} ]
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,
  }
]
Copy to Clipboard Toggle word wrap
4.2.1.15.2. Response 404
{
  "error_code" : 404,
  "message" : "The specified consumer instance was not found."
}
Copy to Clipboard Toggle word wrap
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."
}
Copy to Clipboard Toggle word wrap
4.2.1.15.4. Response 422
{
  "error_code" : 422,
  "message" : "Response exceeds the maximum number of bytes the consumer can receive"
}
Copy to Clipboard Toggle word wrap

4.2.1.16. seek

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

4.2.1.16.1. 説明

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

4.2.1.16.2. パラメーター
Expand
表4.17 パスパラメーター
名前説明必須デフォルトパターン

groupid

コンシューマーが属するコンシューマーグループの ID。

X

null

 

name

サブスクライブされたコンシューマーの名前。

X

null

 
Expand
表4.18 本文パラメーター
名前説明必須デフォルトパターン

OffsetCommitSeekList

サブスクライブされたコンシューマーが次にレコードをフェッチするパーティションオフセットのリスト。OffsetCommitSeekList OffsetCommitSeekList」

X

  
4.2.1.16.3. 戻り値のタイプ

-

4.2.1.16.4. コンテンツタイプ
  • application/vnd.kafka.v2+json
4.2.1.16.5. レスポンス
Expand
表4.19 HTTP レスポンスコード
コードメッセージデータ型

204

シークは正常に実行されました。

<<>>

404

指定されたコンシューマーインスタンスが見つからなかったか、指定されたコンシューマーインスタンスに指定されたパーティションの 1 つが割り当てられていませんでした。

Error Error」

4.2.1.16.6. サンプル

4.2.1.17. HTTP リクエストの例

4.2.1.17.1. リクエストの本文
{
  "offsets" : [ {
    "topic" : "topic",
    "partition" : 0,
    "offset" : 15
  }, {
    "topic" : "topic",
    "partition" : 1,
    "offset" : 42
  } ]
}
Copy to Clipboard Toggle word wrap

4.2.1.18. HTTP レスポンスの例

4.2.1.18.1. Response 404
{
  "error_code" : 404,
  "message" : "The specified consumer instance was not found."
}
Copy to Clipboard Toggle word wrap

4.2.1.19. seekToBeginning

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

4.2.1.19.1. 説明

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

4.2.1.19.2. パラメーター
Expand
表4.20 パスパラメーター
名前説明必須デフォルトパターン

groupid

サブスクライブされたコンシューマーが属するコンシューマーグループの ID。

X

null

 

name

サブスクライブされたコンシューマーの名前。

X

null

 
Expand
表4.21 本文パラメーター
名前説明必須デフォルトパターン

Partitions

コンシューマーがサブスクライブしているトピックパーティションのリスト。コンシューマーは、指定されたパーティションの最初のオフセットを探します。Partitions Partitions」

X

  
4.2.1.19.3. 戻り値のタイプ

-

4.2.1.19.4. コンテンツタイプ
  • application/vnd.kafka.v2+json
4.2.1.19.5. レスポンス
Expand
表4.22 HTTP レスポンスコード
コードメッセージデータ型

204

正常に実行されたものを最初にシークします。

<<>>

404

指定されたコンシューマーインスタンスが見つからなかったか、指定されたコンシューマーインスタンスに指定されたパーティションの 1 つが割り当てられていませんでした。

Error Error」

4.2.1.19.6. サンプル

4.2.1.20. HTTP リクエストの例

4.2.1.20.1. リクエストの本文
{
  "partitions" : [ {
    "topic" : "topic",
    "partition" : 0
  }, {
    "topic" : "topic",
    "partition" : 1
  } ]
}
Copy to Clipboard Toggle word wrap

4.2.1.21. HTTP レスポンスの例

4.2.1.21.1. Response 404
{
  "error_code" : 404,
  "message" : "The specified consumer instance was not found."
}
Copy to Clipboard Toggle word wrap

4.2.1.22. seekToEnd

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

4.2.1.22.1. 説明

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

4.2.1.22.2. パラメーター
Expand
表4.23 パスパラメーター
名前説明必須デフォルトパターン

groupid

サブスクライブされたコンシューマーが属するコンシューマーグループの ID。

X

null

 

name

サブスクライブされたコンシューマーの名前。

X

null

 
Expand
表4.24 本文パラメーター
名前説明必須デフォルトパターン

Partitions

コンシューマーがサブスクライブしているトピックパーティションのリスト。コンシューマーは、指定されたパーティションの最後のオフセットをシークします。Partitions Partitions」

X

  
4.2.1.22.3. 戻り値のタイプ

-

4.2.1.22.4. コンテンツタイプ
  • application/vnd.kafka.v2+json
4.2.1.22.5. レスポンス
Expand
表4.25 HTTP レスポンスコード
コードメッセージデータ型

204

最後に正常に実行されたものをシークします。

<<>>

404

指定されたコンシューマーインスタンスが見つからなかったか、指定されたコンシューマーインスタンスに指定されたパーティションの 1 つが割り当てられていませんでした。

Error Error」

4.2.1.22.6. サンプル

4.2.1.23. HTTP リクエストの例

4.2.1.23.1. リクエストの本文
{
  "partitions" : [ {
    "topic" : "topic",
    "partition" : 0
  }, {
    "topic" : "topic",
    "partition" : 1
  } ]
}
Copy to Clipboard Toggle word wrap

4.2.1.24. HTTP レスポンスの例

4.2.1.24.1. Response 404
{
  "error_code" : 404,
  "message" : "The specified consumer instance was not found."
}
Copy to Clipboard Toggle word wrap

4.2.1.26. HTTP リクエストの例

4.2.1.26.1. リクエストの本文
{
  "topics" : [ "topic1", "topic2" ]
}
Copy to Clipboard Toggle word wrap

4.2.1.27. HTTP レスポンスの例

4.2.1.27.1. Response 404
{
  "error_code" : 404,
  "message" : "The specified consumer instance was not found."
}
Copy to Clipboard Toggle word wrap
4.2.1.27.2. Response 409
{
  "error_code" : 409,
  "message" : "Subscriptions to topics, partitions, and patterns are mutually exclusive."
}
Copy to Clipboard Toggle word wrap
4.2.1.27.3. Response 422
{
  "error_code" : 422,
  "message" : "A list (of Topics type) or a topic_pattern must be specified."
}
Copy to Clipboard Toggle word wrap

4.2.1.28. unsubscribe

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

4.2.1.28.1. 説明

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

4.2.1.28.2. パラメーター
Expand
表4.29 パスパラメーター
名前説明必須デフォルトパターン

groupid

サブスクライブされたコンシューマーが属するコンシューマーグループの ID。

X

null

 

name

トピックからサブスクライブを解除するコンシューマーの名前。

X

null

 
4.2.1.28.3. 戻り値のタイプ

-

4.2.1.28.4. コンテンツタイプ
  • application/json
4.2.1.28.5. レスポンス
Expand
表4.30 HTTP レスポンスコード
コードメッセージデータ型

204

コンシューマーは正常にサブスクライブを解除しました。

<<>>

404

指定されたコンシューマーインスタンスが見つかりませんでした。

Error Error」

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."
}
Copy to Clipboard Toggle word wrap

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. レスポンス
Expand
表4.31 HTTP レスポンスコード
コードメッセージデータ型

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. 戻り値のタイプ

BridgeInfo BridgeInfo」

4.2.2.2.4. コンテンツタイプ
  • application/json
4.2.2.2.5. レスポンス
Expand
表4.32 HTTP レスポンスコード
コードメッセージデータ型

200

Kafka Bridge インスタンスに関する情報。

BridgeInfo BridgeInfo」

4.2.2.2.6. サンプル

4.2.2.3. HTTP レスポンスの例

4.2.2.3.1. Response 200
{
  "bridge_version" : 2.8
}
Copy to Clipboard Toggle word wrap

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. レスポンス
Expand
表4.33 HTTP レスポンスコード
コードメッセージデータ型

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. レスポンス
Expand
表4.34 HTTP レスポンスコード
コードメッセージデータ型

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. レスポンス
Expand
表4.35 HTTP レスポンスコード
コードメッセージデータ型

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. レスポンス
Expand
表4.36 HTTP レスポンスコード
コードメッセージデータ型

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. レスポンス
Expand
表4.37 HTTP レスポンスコード
コードメッセージデータ型

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. パラメーター
Expand
表4.38 パスパラメーター
名前説明必須デフォルトパターン

topicname

レコードの送信先またはメタデータの取得元のトピックの名前。

X

null

 
Expand
表4.39 本文パラメーター
名前説明必須デフォルトパターン

ProducerRecordList

ProducerRecordList ProducerRecordList」

X

  
Expand
表4.40 クエリーパラメーター
名前説明必須デフォルトパターン

async

送信操作の結果としてのメタデータを無視し、クライアントに返しません。指定されていない場合は false となり、メタデータが返されます。

-

null

 
4.2.3.1.3. 戻り値のタイプ

OffsetRecordSentList OffsetRecordSentList」

4.2.3.1.4. コンテンツタイプ
  • application/vnd.kafka.v2+json
4.2.3.1.5. レスポンス
Expand
表4.41 HTTP レスポンスコード
コードメッセージデータ型

200

レコードは正常に送信されました。

OffsetRecordSentList OffsetRecordSentList」

404

指定されたトピックが見つかりませんでした。

Error Error」

422

レコードリストが無効です。

Error Error」

4.2.3.1.6. サンプル

4.2.3.2. HTTP リクエストの例

4.2.3.2.1. リクエストの本文
{
  "records" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "value" : "value2",
    "partition" : 1
  }, {
    "value" : "value3"
  } ]
}
Copy to Clipboard Toggle word wrap

4.2.3.3. HTTP レスポンスの例

4.2.3.3.1. Response 200
{
  "offsets" : [ {
    "partition" : 2,
    "offset" : 0
  }, {
    "partition" : 1,
    "offset" : 1
  }, {
    "partition" : 2,
    "offset" : 2
  } ]
}
Copy to Clipboard Toggle word wrap
4.2.3.3.2. Response 404
{
  "error_code" : 404,
  "message" : "The specified topic was not found."
}
Copy to Clipboard Toggle word wrap
4.2.3.3.3. Response 422
{
  "error_code" : 422,
  "message" : "The record list contains invalid records."
}
Copy to Clipboard Toggle word wrap

4.2.3.4. sendToPartition

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

4.2.3.4.1. 説明

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

4.2.3.4.2. パラメーター
Expand
表4.42 パスパラメーター
名前説明必須デフォルトパターン

topicname

レコードの送信先またはメタデータの取得元のトピックの名前。

X

null

 

partitionid

レコードを送信したり、メタデータを取得したりするパーティションの ID。

X

null

 
Expand
表4.43 本文パラメーター
名前説明必須デフォルトパターン

ProducerRecordToPartitionList

値 (必須) とキー (任意) を含む、特定のトピックパーティションに送信するレコードのリスト。ProducerRecordToPartitionList ProducerRecordToPartitionList」

X

  
Expand
表4.44 クエリーパラメーター
名前説明必須デフォルトパターン

async

メタデータを待機する代わりに、レコードの送信直後に返すかどうか。指定されている場合はオフセットは返されません。デフォルトは false です。

-

null

 
4.2.3.4.3. 戻り値のタイプ

OffsetRecordSentList OffsetRecordSentList」

4.2.3.4.4. コンテンツタイプ
  • application/vnd.kafka.v2+json
4.2.3.4.5. レスポンス
Expand
表4.45 HTTP レスポンスコード
コードメッセージデータ型

200

レコードは正常に送信されました。

OffsetRecordSentList OffsetRecordSentList」

404

指定されたトピックパーティションが見つかりませんでした。

Error Error」

422

レコードが無効です。

Error Error」

4.2.3.4.6. サンプル

4.2.3.5. HTTP リクエストの例

4.2.3.5.1. リクエストの本文
{
  "records" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "value" : "value2"
  } ]
}
Copy to Clipboard Toggle word wrap

4.2.3.6. HTTP レスポンスの例

4.2.3.6.1. Response 200
{
  "offsets" : [ {
    "partition" : 2,
    "offset" : 0
  }, {
    "partition" : 1,
    "offset" : 1
  }, {
    "partition" : 2,
    "offset" : 2
  } ]
}
Copy to Clipboard Toggle word wrap
4.2.3.6.2. Response 404
{
  "error_code" : 404,
  "message" : "The specified topic partition was not found."
}
Copy to Clipboard Toggle word wrap
4.2.3.6.3. Response 422
{
  "error_code" : 422,
  "message" : "The record is not valid."
}
Copy to Clipboard Toggle word wrap

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. パラメーター
Expand
表4.46 パスパラメーター
名前説明必須デフォルトパターン

groupid

コンシューマーが属するコンシューマーグループの ID。

X

null

 

name

サブスクライブされたコンシューマーの名前。

X

null

 
Expand
表4.47 本文パラメーター
名前説明必須デフォルトパターン

OffsetCommitSeekList

サブスクライブされたコンシューマーが次にレコードをフェッチするパーティションオフセットのリスト。OffsetCommitSeekList OffsetCommitSeekList」

X

  
4.2.4.1.3. 戻り値のタイプ

-

4.2.4.1.4. コンテンツタイプ
  • application/vnd.kafka.v2+json
4.2.4.1.5. レスポンス
Expand
表4.48 HTTP レスポンスコード
コードメッセージデータ型

204

シークは正常に実行されました。

<<>>

404

指定されたコンシューマーインスタンスが見つからなかったか、指定されたコンシューマーインスタンスに指定されたパーティションの 1 つが割り当てられていませんでした。

Error Error」

4.2.4.1.6. サンプル

4.2.4.2. HTTP リクエストの例

4.2.4.2.1. リクエストの本文
{
  "offsets" : [ {
    "topic" : "topic",
    "partition" : 0,
    "offset" : 15
  }, {
    "topic" : "topic",
    "partition" : 1,
    "offset" : 42
  } ]
}
Copy to Clipboard Toggle word wrap

4.2.4.3. HTTP レスポンスの例

4.2.4.3.1. Response 404
{
  "error_code" : 404,
  "message" : "The specified consumer instance was not found."
}
Copy to Clipboard Toggle word wrap

4.2.4.4. seekToBeginning

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

4.2.4.4.1. 説明

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

4.2.4.4.2. パラメーター
Expand
表4.49 パスパラメーター
名前説明必須デフォルトパターン

groupid

サブスクライブされたコンシューマーが属するコンシューマーグループの ID。

X

null

 

name

サブスクライブされたコンシューマーの名前。

X

null

 
Expand
表4.50 本文パラメーター
名前説明必須デフォルトパターン

Partitions

コンシューマーがサブスクライブしているトピックパーティションのリスト。コンシューマーは、指定されたパーティションの最初のオフセットを探します。Partitions Partitions」

X

  
4.2.4.4.3. 戻り値のタイプ

-

4.2.4.4.4. コンテンツタイプ
  • application/vnd.kafka.v2+json
4.2.4.4.5. レスポンス
Expand
表4.51 HTTP レスポンスコード
コードメッセージデータ型

204

正常に実行されたものを最初にシークします。

<<>>

404

指定されたコンシューマーインスタンスが見つからなかったか、指定されたコンシューマーインスタンスに指定されたパーティションの 1 つが割り当てられていませんでした。

Error Error」

4.2.4.4.6. サンプル

4.2.4.5. HTTP リクエストの例

4.2.4.5.1. リクエストの本文
{
  "partitions" : [ {
    "topic" : "topic",
    "partition" : 0
  }, {
    "topic" : "topic",
    "partition" : 1
  } ]
}
Copy to Clipboard Toggle word wrap

4.2.4.6. HTTP レスポンスの例

4.2.4.6.1. Response 404
{
  "error_code" : 404,
  "message" : "The specified consumer instance was not found."
}
Copy to Clipboard Toggle word wrap

4.2.4.7. seekToEnd

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

4.2.4.7.1. 説明

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

4.2.4.7.2. パラメーター
Expand
表4.52 パスパラメーター
名前説明必須デフォルトパターン

groupid

サブスクライブされたコンシューマーが属するコンシューマーグループの ID。

X

null

 

name

サブスクライブされたコンシューマーの名前。

X

null

 
Expand
表4.53 本文パラメーター
名前説明必須デフォルトパターン

Partitions

コンシューマーがサブスクライブしているトピックパーティションのリスト。コンシューマーは、指定されたパーティションの最後のオフセットをシークします。Partitions Partitions」

X

  
4.2.4.7.3. 戻り値のタイプ

-

4.2.4.7.4. コンテンツタイプ
  • application/vnd.kafka.v2+json
4.2.4.7.5. レスポンス
Expand
表4.54 HTTP レスポンスコード
コードメッセージデータ型

204

最後に正常に実行されたものをシークします。

<<>>

404

指定されたコンシューマーインスタンスが見つからなかったか、指定されたコンシューマーインスタンスに指定されたパーティションの 1 つが割り当てられていませんでした。

Error Error」

4.2.4.7.6. サンプル

4.2.4.8. HTTP リクエストの例

4.2.4.8.1. リクエストの本文
{
  "partitions" : [ {
    "topic" : "topic",
    "partition" : 0
  }, {
    "topic" : "topic",
    "partition" : 1
  } ]
}
Copy to Clipboard Toggle word wrap

4.2.4.9. HTTP レスポンスの例

4.2.4.9.1. Response 404
{
  "error_code" : 404,
  "message" : "The specified consumer instance was not found."
}
Copy to Clipboard Toggle word wrap

4.2.5. トピック

4.2.5.1. getOffsets

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

4.2.5.1.1. 説明

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

4.2.5.1.2. パラメーター
Expand
表4.55 パスパラメーター
名前説明必須デフォルトパターン

topicname

パーティションを含むトピックの名前。

X

null

 

partitionid

パーティションの ID。

X

null

 
4.2.5.1.3. 戻り値のタイプ

OffsetsSummary OffsetsSummary」

4.2.5.1.4. コンテンツタイプ
  • application/vnd.kafka.v2+json
4.2.5.1.5. レスポンス
Expand
表4.56 HTTP レスポンスコード
コードメッセージデータ型

200

トピックパーティションのオフセットの概要。

OffsetsSummary OffsetsSummary」

404

指定されたトピックパーティションが見つかりませんでした。

Error Error」

4.2.5.1.6. サンプル

4.2.5.2. HTTP レスポンスの例

4.2.5.2.1. Response 200
{
  "beginning_offset" : 10,
  "end_offset" : 50
}
Copy to Clipboard Toggle word wrap
4.2.5.2.2. Response 404
{
  "error_code" : 404,
  "message" : "The specified topic partition was not found."
}
Copy to Clipboard Toggle word wrap

4.2.5.3. getPartition

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

4.2.5.3.1. 説明

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

4.2.5.3.2. パラメーター
Expand
表4.57 パスパラメーター
名前説明必須デフォルトパターン

topicname

レコードの送信先またはメタデータの取得元のトピックの名前。

X

null

 

partitionid

レコードを送信したり、メタデータを取得したりするパーティションの ID。

X

null

 
4.2.5.3.3. 戻り値のタイプ

PartitionMetadata PartitionMetadata」

4.2.5.3.4. コンテンツタイプ
  • application/vnd.kafka.v2+json
4.2.5.3.5. レスポンス
Expand
表4.58 HTTP レスポンスコード
コードメッセージデータ型

200

パーティションメタデータ

PartitionMetadata PartitionMetadata」

404

指定されたパーティションが見つかりませんでした。

Error Error」

4.2.5.3.6. サンプル

4.2.5.4. HTTP レスポンスの例

4.2.5.4.1. Response 200
{
  "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
4.2.5.4.2. Response 404
{
  "error_code" : 404,
  "message" : "The specified topic partition was not found."
}
Copy to Clipboard Toggle word wrap

4.2.5.5. getTopic

GET /topics/{topicname}

4.2.5.5.1. 説明

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

4.2.5.5.2. パラメーター
Expand
表4.59 パスパラメーター
名前説明必須デフォルトパターン

topicname

レコードの送信先またはメタデータの取得元のトピックの名前。

X

null

 
4.2.5.5.3. 戻り値のタイプ

TopicMetadata TopicMetadata」

4.2.5.5.4. コンテンツタイプ
  • application/vnd.kafka.v2+json
4.2.5.5.5. レスポンス
Expand
表4.60 HTTP レスポンスコード
コードメッセージデータ型

200

トピックのメタデータ

TopicMetadata TopicMetadata」

404

指定されたトピックが見つかりませんでした。

Error Error」

4.2.5.5.6. サンプル

4.2.5.6. HTTP レスポンスの例

4.2.5.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
    } ]
  } ]
}
Copy to Clipboard Toggle word wrap

4.2.5.7. listPartitions

GET /topics/{topicname}/partitions

4.2.5.7.1. 説明

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

4.2.5.7.2. パラメーター
Expand
表4.61 パスパラメーター
名前説明必須デフォルトパターン

topicname

レコードの送信先またはメタデータの取得元のトピックの名前。

X

null

 
4.2.5.7.3. 戻り値のタイプ

array[PartitionMetadata PartitionMetadata」]

4.2.5.7.4. コンテンツタイプ
  • application/vnd.kafka.v2+json
4.2.5.7.5. レスポンス
Expand
表4.62 HTTP レスポンスコード
コードメッセージデータ型

200

パーティションのリスト。

List[PartitionMetadata PartitionMetadata」]

404

指定されたトピックが見つかりませんでした。

Error Error」

4.2.5.7.6. サンプル

4.2.5.8. HTTP レスポンスの例

4.2.5.8.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
  } ]
} ]
Copy to Clipboard Toggle word wrap
4.2.5.8.2. Response 404
{
  "error_code" : 404,
  "message" : "The specified topic was not found."
}
Copy to Clipboard Toggle word wrap

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. レスポンス
Expand
表4.63 HTTP レスポンスコード
コードメッセージデータ型

200

トピックのリスト。

List[String]

4.2.5.9.6. サンプル

4.2.5.10. HTTP レスポンスの例

4.2.5.10.1. Response 200
[ "topic1", "topic2" ]
Copy to Clipboard Toggle word wrap

4.2.5.11. send

POST /topics/{topicname}

4.2.5.11.1. 説明

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

4.2.5.11.2. パラメーター
Expand
表4.64 パスパラメーター
名前説明必須デフォルトパターン

topicname

レコードの送信先またはメタデータの取得元のトピックの名前。

X

null

 
Expand
表4.65 本文パラメーター
名前説明必須デフォルトパターン

ProducerRecordList

ProducerRecordList ProducerRecordList」

X

  
Expand
表4.66 クエリーパラメーター
名前説明必須デフォルトパターン

async

送信操作の結果としてのメタデータを無視し、クライアントに返しません。指定されていない場合は false となり、メタデータが返されます。

-

null

 
4.2.5.11.3. 戻り値のタイプ

OffsetRecordSentList OffsetRecordSentList」

4.2.5.11.4. コンテンツタイプ
  • application/vnd.kafka.v2+json
4.2.5.11.5. レスポンス
Expand
表4.67 HTTP レスポンスコード
コードメッセージデータ型

200

レコードは正常に送信されました。

OffsetRecordSentList OffsetRecordSentList」

404

指定されたトピックが見つかりませんでした。

Error Error」

422

レコードリストが無効です。

Error Error」

4.2.5.11.6. サンプル

4.2.5.12. HTTP リクエストの例

4.2.5.12.1. リクエストの本文
{
  "records" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "value" : "value2",
    "partition" : 1
  }, {
    "value" : "value3"
  } ]
}
Copy to Clipboard Toggle word wrap

4.2.5.13. HTTP レスポンスの例

4.2.5.13.1. Response 200
{
  "offsets" : [ {
    "partition" : 2,
    "offset" : 0
  }, {
    "partition" : 1,
    "offset" : 1
  }, {
    "partition" : 2,
    "offset" : 2
  } ]
}
Copy to Clipboard Toggle word wrap
4.2.5.13.2. Response 404
{
  "error_code" : 404,
  "message" : "The specified topic was not found."
}
Copy to Clipboard Toggle word wrap
4.2.5.13.3. Response 422
{
  "error_code" : 422,
  "message" : "The record list contains invalid records."
}
Copy to Clipboard Toggle word wrap

4.2.5.14. sendToPartition

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

4.2.5.14.1. 説明

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

4.2.5.14.2. パラメーター
Expand
表4.68 パスパラメーター
名前説明必須デフォルトパターン

topicname

レコードの送信先またはメタデータの取得元のトピックの名前。

X

null

 

partitionid

レコードを送信したり、メタデータを取得したりするパーティションの ID。

X

null

 
Expand
表4.69 本文パラメーター
名前説明必須デフォルトパターン

ProducerRecordToPartitionList

値 (必須) とキー (任意) を含む、特定のトピックパーティションに送信するレコードのリスト。ProducerRecordToPartitionList ProducerRecordToPartitionList」

X

  
Expand
表4.70 クエリーパラメーター
名前説明必須デフォルトパターン

async

メタデータを待機する代わりに、レコードの送信直後に返すかどうか。指定されている場合はオフセットは返されません。デフォルトは false です。

-

null

 
4.2.5.14.3. 戻り値のタイプ

OffsetRecordSentList OffsetRecordSentList」

4.2.5.14.4. コンテンツタイプ
  • application/vnd.kafka.v2+json
4.2.5.14.5. レスポンス
Expand
表4.71 HTTP レスポンスコード
コードメッセージデータ型

200

レコードは正常に送信されました。

OffsetRecordSentList OffsetRecordSentList」

404

指定されたトピックパーティションが見つかりませんでした。

Error Error」

422

レコードが無効です。

Error Error」

4.2.5.14.6. サンプル

4.2.5.15. HTTP リクエストの例

4.2.5.15.1. リクエストの本文
{
  "records" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "value" : "value2"
  } ]
}
Copy to Clipboard Toggle word wrap

4.2.5.16. HTTP レスポンスの例

4.2.5.16.1. Response 200
{
  "offsets" : [ {
    "partition" : 2,
    "offset" : 0
  }, {
    "partition" : 1,
    "offset" : 1
  }, {
    "partition" : 2,
    "offset" : 2
  } ]
}
Copy to Clipboard Toggle word wrap
4.2.5.16.2. Response 404
{
  "error_code" : 404,
  "message" : "The specified topic partition was not found."
}
Copy to Clipboard Toggle word wrap
4.2.5.16.3. Response 422
{
  "error_code" : 422,
  "message" : "The record is not valid."
}
Copy to Clipboard Toggle word wrap
トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat