4.3. 路径
4.3.1. GET / 复制链接链接已复制到粘贴板!
4.3.1.1. 描述 复制链接链接已复制到粘贴板!
以 JSON 格式检索 Kafka Bridge 实例的信息。
4.3.1.2. 响应 复制链接链接已复制到粘贴板!
HTTP 代码 | 描述 | 模式 |
---|---|---|
200 | 有关 Kafka Bridge 实例的信息。 |
4.3.1.3. produces 复制链接链接已复制到粘贴板!
-
application/json
4.3.1.4. HTTP 响应示例 复制链接链接已复制到粘贴板!
4.3.1.4.1. 响应 200 复制链接链接已复制到粘贴板!
{ "bridge_version" : "0.16.0" }
{
"bridge_version" : "0.16.0"
}
4.3.2. POST /consumers/{groupid} 复制链接链接已复制到粘贴板!
4.3.2.1. 描述 复制链接链接已复制到粘贴板!
在给定的消费者组中创建一个消费者实例。您可以选择指定消费者名称和支持的配置选项。它返回一个基础 URI,用于针对这个消费者实例后续请求构建 URL。
4.3.2.2. 参数 复制链接链接已复制到粘贴板!
类型 | Name | 描述 | 模式 |
---|---|---|---|
路径 |
GroupId | 要创建消费者的消费者组的 ID。 | 字符串 |
Body |
body | 消费者的名称和配置。该名称在消费者组的范围中是唯一的。如果没有指定名称,则会分配一个随机生成的名称。所有参数都是可选的。以下示例中显示了支持的配置选项。 |
4.3.2.3. 响应 复制链接链接已复制到粘贴板!
HTTP 代码 | 描述 | 模式 |
---|---|---|
200 | 使用者创建成功。 | |
409 | Kafka Bridge 中已存在具有指定名称的消费者实例。 | |
422 | 一个或多个消费者配置选项具有无效的值。 |
4.3.2.4. 使用 复制链接链接已复制到粘贴板!
-
application/vnd.kafka.v2+json
4.3.2.5. produces 复制链接链接已复制到粘贴板!
-
application/vnd.kafka.v2+json
4.3.2.6. Tags 复制链接链接已复制到粘贴板!
- 消费者
4.3.2.7. HTTP 请求示例 复制链接链接已复制到粘贴板!
4.3.2.7.1. 请求正文 复制链接链接已复制到粘贴板!
4.3.2.8. HTTP 响应示例 复制链接链接已复制到粘贴板!
4.3.2.8.1. 响应 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.3.2.8.2. 响应 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.3.2.8.3. 响应 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.3.3. DELETE /consumers/{groupid}/instances/{name} 复制链接链接已复制到粘贴板!
4.3.3.1. 描述 复制链接链接已复制到粘贴板!
删除指定的消费者实例。此操作请求 MUST 使用从 POST
请求返回的基本 URL (包括主机和端口)到用于创建此消费者的 /consumers/{groupid}
。
4.3.3.2. 参数 复制链接链接已复制到粘贴板!
类型 | Name | 描述 | 模式 |
---|---|---|---|
路径 |
GroupId | 消费者所属的消费者组的 ID。 | 字符串 |
路径 |
name | 要删除的消费者的名称。 | 字符串 |
4.3.3.3. 响应 复制链接链接已复制到粘贴板!
HTTP 代码 | 描述 | 模式 |
---|---|---|
204 | 使用者删除成功。 | 无内容 |
404 | 未找到指定的消费者实例。 |
4.3.3.4. 使用 复制链接链接已复制到粘贴板!
-
application/vnd.kafka.v2+json
4.3.3.5. produces 复制链接链接已复制到粘贴板!
-
application/vnd.kafka.v2+json
4.3.3.6. Tags 复制链接链接已复制到粘贴板!
- 消费者
4.3.3.7. HTTP 响应示例 复制链接链接已复制到粘贴板!
4.3.3.7.1. 响应 404 复制链接链接已复制到粘贴板!
{ "error_code" : 404, "message" : "The specified consumer instance was not found." }
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
4.3.4.1. 描述 复制链接链接已复制到粘贴板!
将一个或多个主题分区分配给消费者。
4.3.4.2. 参数 复制链接链接已复制到粘贴板!
类型 | Name | 描述 | 模式 |
---|---|---|---|
路径 |
GroupId | 消费者所属的消费者组的 ID。 | 字符串 |
路径 |
name | 分配主题分区的消费者的名称。 | 字符串 |
Body |
body | 分配给消费者的主题分区列表。 |
4.3.4.3. 响应 复制链接链接已复制到粘贴板!
4.3.4.4. 使用 复制链接链接已复制到粘贴板!
-
application/vnd.kafka.v2+json
4.3.4.5. produces 复制链接链接已复制到粘贴板!
-
application/vnd.kafka.v2+json
4.3.4.6. Tags 复制链接链接已复制到粘贴板!
- 消费者
4.3.4.7. HTTP 请求示例 复制链接链接已复制到粘贴板!
4.3.4.7.1. 请求正文 复制链接链接已复制到粘贴板!
4.3.4.8. HTTP 响应示例 复制链接链接已复制到粘贴板!
4.3.4.8.1. 响应 404 复制链接链接已复制到粘贴板!
{ "error_code" : 404, "message" : "The specified consumer instance was not found." }
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
4.3.4.8.2. 响应 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.3.5.1. 描述 复制链接链接已复制到粘贴板!
提交使用者偏移列表。要提交使用者获取的所有记录的偏移,请将请求正文留空。
4.3.5.2. 参数 复制链接链接已复制到粘贴板!
类型 | Name | 描述 | 模式 |
---|---|---|---|
路径 |
GroupId | 消费者所属的消费者组的 ID。 | 字符串 |
路径 |
name | 使用者的名称。 | 字符串 |
Body |
body | 提交到消费者偏移日志的消费者偏移列表。您可以指定一个或多个主题分区来提交偏移。 |
4.3.5.3. 响应 复制链接链接已复制到粘贴板!
HTTP 代码 | 描述 | 模式 |
---|---|---|
204 | 提交成功。 | 无内容 |
404 | 未找到指定的消费者实例。 |
4.3.5.4. 使用 复制链接链接已复制到粘贴板!
-
application/vnd.kafka.v2+json
4.3.5.5. produces 复制链接链接已复制到粘贴板!
-
application/vnd.kafka.v2+json
4.3.5.6. Tags 复制链接链接已复制到粘贴板!
- 消费者
4.3.5.7. HTTP 请求示例 复制链接链接已复制到粘贴板!
4.3.5.7.1. 请求正文 复制链接链接已复制到粘贴板!
4.3.5.8. HTTP 响应示例 复制链接链接已复制到粘贴板!
4.3.5.8.1. 响应 404 复制链接链接已复制到粘贴板!
{ "error_code" : 404, "message" : "The specified consumer instance was not found." }
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
4.3.6.1. 描述 复制链接链接已复制到粘贴板!
配置订阅的消费者,以便在下次从给定主题分区获取一组记录时从特定偏移获取偏移。这会覆盖使用者的默认获取行为。您可以指定一个或多个主题分区。
4.3.6.2. 参数 复制链接链接已复制到粘贴板!
类型 | Name | 描述 | 模式 |
---|---|---|---|
路径 |
GroupId | 消费者所属的消费者组的 ID。 | 字符串 |
路径 |
name | 订阅消费者的名称。 | 字符串 |
Body |
body | 订阅消费者以后从中获取记录的分区偏移列表。 |
4.3.6.3. 响应 复制链接链接已复制到粘贴板!
HTTP 代码 | 描述 | 模式 |
---|---|---|
204 | seek 执行成功。 | 无内容 |
404 | 未找到指定的消费者实例,或者指定的消费者实例没有分配其中一个指定分区。 |
4.3.6.4. 使用 复制链接链接已复制到粘贴板!
-
application/vnd.kafka.v2+json
4.3.6.5. produces 复制链接链接已复制到粘贴板!
-
application/vnd.kafka.v2+json
4.3.6.6. Tags 复制链接链接已复制到粘贴板!
- 消费者
- seek
4.3.6.7. HTTP 请求示例 复制链接链接已复制到粘贴板!
4.3.6.7.1. 请求正文 复制链接链接已复制到粘贴板!
4.3.6.8. HTTP 响应示例 复制链接链接已复制到粘贴板!
4.3.6.8.1. 响应 404 复制链接链接已复制到粘贴板!
{ "error_code" : 404, "message" : "The specified consumer instance was not found." }
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
4.3.7.1. 描述 复制链接链接已复制到粘贴板!
将订阅的消费者配置为 (然后读取)一个或多个给定主题分区中的第一个偏移。
4.3.7.2. 参数 复制链接链接已复制到粘贴板!
类型 | Name | 描述 | 模式 |
---|---|---|---|
路径 |
GroupId | 订阅消费者所属的消费者组的 ID。 | 字符串 |
路径 |
name | 订阅消费者的名称。 | 字符串 |
Body |
body | 消费者订阅的主题分区列表。消费者将发现指定分区中的第一个偏移。 |
4.3.7.3. 响应 复制链接链接已复制到粘贴板!
HTTP 代码 | 描述 | 模式 |
---|---|---|
204 | 预见到开始已成功执行。 | 无内容 |
404 | 未找到指定的消费者实例,或者指定的消费者实例没有分配其中一个指定分区。 |
4.3.7.4. 使用 复制链接链接已复制到粘贴板!
-
application/vnd.kafka.v2+json
4.3.7.5. produces 复制链接链接已复制到粘贴板!
-
application/vnd.kafka.v2+json
4.3.7.6. Tags 复制链接链接已复制到粘贴板!
- 消费者
- seek
4.3.7.7. HTTP 请求示例 复制链接链接已复制到粘贴板!
4.3.7.7.1. 请求正文 复制链接链接已复制到粘贴板!
4.3.7.8. HTTP 响应示例 复制链接链接已复制到粘贴板!
4.3.7.8.1. 响应 404 复制链接链接已复制到粘贴板!
{ "error_code" : 404, "message" : "The specified consumer instance was not found." }
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
4.3.8.1. 描述 复制链接链接已复制到粘贴板!
将订阅的消费者配置为 (并从中读取)给定主题分区末尾的偏移量。
4.3.8.2. 参数 复制链接链接已复制到粘贴板!
类型 | Name | 描述 | 模式 |
---|---|---|---|
路径 |
GroupId | 订阅消费者所属的消费者组的 ID。 | 字符串 |
路径 |
name | 订阅消费者的名称。 | 字符串 |
Body |
body | 消费者订阅的主题分区列表。消费者将发现指定分区中的最后一个偏移量。 |
4.3.8.3. 响应 复制链接链接已复制到粘贴板!
HTTP 代码 | 描述 | 模式 |
---|---|---|
204 | 禁止成功执行了最后的执行。 | 无内容 |
404 | 未找到指定的消费者实例,或者指定的消费者实例没有分配其中一个指定分区。 |
4.3.8.4. 使用 复制链接链接已复制到粘贴板!
-
application/vnd.kafka.v2+json
4.3.8.5. produces 复制链接链接已复制到粘贴板!
-
application/vnd.kafka.v2+json
4.3.8.6. Tags 复制链接链接已复制到粘贴板!
- 消费者
- seek
4.3.8.7. HTTP 请求示例 复制链接链接已复制到粘贴板!
4.3.8.7.1. 请求正文 复制链接链接已复制到粘贴板!
4.3.8.8. HTTP 响应示例 复制链接链接已复制到粘贴板!
4.3.8.8.1. 响应 404 复制链接链接已复制到粘贴板!
{ "error_code" : 404, "message" : "The specified consumer instance was not found." }
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
4.3.9. GET /consumers/{groupid}/instances/{name}/records 复制链接链接已复制到粘贴板!
4.3.9.1. 描述 复制链接链接已复制到粘贴板!
检索订阅消费者的记录,包括消息值、主题和分区。此操作请求 MUST 使用从 POST
请求返回的基本 URL (包括主机和端口)到用于创建此消费者的 /consumers/{groupid}
。
4.3.9.2. 参数 复制链接链接已复制到粘贴板!
类型 | Name | 描述 | 模式 |
---|---|---|---|
路径 |
GroupId | 订阅消费者所属的消费者组的 ID。 | 字符串 |
路径 |
name | 从中检索记录的订阅消费者的名称。 | 字符串 |
查询 |
max_bytes | 响应中可包含的未编码键和值的最大大小(以字节为单位)。否则,会返回带有代码 422 的错误响应。 | 整数 |
查询 |
timeout | HTTP 网桥在超时请求前检索记录的最大时间(以毫秒为单位)。 | 整数 |
4.3.9.3. 响应 复制链接链接已复制到粘贴板!
HTTP 代码 | 描述 | 模式 |
---|---|---|
200 | 轮询请求成功执行。 | |
404 | 未找到指定的消费者实例。 | |
406 |
消费者创建请求中使用的 | |
422 | 响应超过消费者可以接收的最大字节数 |
4.3.9.4. produces 复制链接链接已复制到粘贴板!
-
application/vnd.kafka.json.v2+json
-
application/vnd.kafka.binary.v2+json
-
application/vnd.kafka.v2+json
4.3.9.5. Tags 复制链接链接已复制到粘贴板!
- 消费者
4.3.9.6. HTTP 响应示例 复制链接链接已复制到粘贴板!
4.3.9.6.1. 响应 200 复制链接链接已复制到粘贴板!
4.3.9.6.2. 响应 404 复制链接链接已复制到粘贴板!
{ "error_code" : 404, "message" : "The specified consumer instance was not found." }
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
4.3.9.6.3. 响应 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.3.9.6.4. 响应 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.3.10.1. 描述 复制链接链接已复制到粘贴板!
为一个或多个主题订阅消费者。您可以描述消费者在列表(主题类型)或 topic_pattern
字段中订阅 的主题
。每个调用都替换订阅者的订阅。
4.3.10.2. 参数 复制链接链接已复制到粘贴板!
类型 | Name | 描述 | 模式 |
---|---|---|---|
路径 |
GroupId | 订阅消费者所属的消费者组的 ID。 | 字符串 |
路径 |
name | 订阅主题的消费者的名称。 | 字符串 |
Body |
body | 消费者要订阅的主题列表。 |
4.3.10.3. 响应 复制链接链接已复制到粘贴板!
4.3.10.4. 使用 复制链接链接已复制到粘贴板!
-
application/vnd.kafka.v2+json
4.3.10.5. produces 复制链接链接已复制到粘贴板!
-
application/vnd.kafka.v2+json
4.3.10.6. Tags 复制链接链接已复制到粘贴板!
- 消费者
4.3.10.7. HTTP 请求示例 复制链接链接已复制到粘贴板!
4.3.10.7.1. 请求正文 复制链接链接已复制到粘贴板!
{ "topics" : [ "topic1", "topic2" ] }
{
"topics" : [ "topic1", "topic2" ]
}
4.3.10.8. HTTP 响应示例 复制链接链接已复制到粘贴板!
4.3.10.8.1. 响应 404 复制链接链接已复制到粘贴板!
{ "error_code" : 404, "message" : "The specified consumer instance was not found." }
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
4.3.10.8.2. 响应 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.3.10.8.3. 响应 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.3.11.1. 描述 复制链接链接已复制到粘贴板!
检索消费者订阅的主题列表。
4.3.11.2. 参数 复制链接链接已复制到粘贴板!
类型 | Name | 描述 | 模式 |
---|---|---|---|
路径 |
GroupId | 订阅消费者所属的消费者组的 ID。 | 字符串 |
路径 |
name | 订阅消费者的名称。 | 字符串 |
4.3.11.3. 响应 复制链接链接已复制到粘贴板!
HTTP 代码 | 描述 | 模式 |
---|---|---|
200 | 订阅的主题和分区列表。 | |
404 | 未找到指定的消费者实例。 |
4.3.11.4. produces 复制链接链接已复制到粘贴板!
-
application/vnd.kafka.v2+json
4.3.11.5. Tags 复制链接链接已复制到粘贴板!
- 消费者
4.3.11.6. HTTP 响应示例 复制链接链接已复制到粘贴板!
4.3.11.6.1. 响应 200 复制链接链接已复制到粘贴板!
4.3.11.6.2. 响应 404 复制链接链接已复制到粘贴板!
{ "error_code" : 404, "message" : "The specified consumer instance was not found." }
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
4.3.12.1. 描述 复制链接链接已复制到粘贴板!
取消订阅所有主题的使用者。
4.3.12.2. 参数 复制链接链接已复制到粘贴板!
类型 | Name | 描述 | 模式 |
---|---|---|---|
路径 |
GroupId | 订阅消费者所属的消费者组的 ID。 | 字符串 |
路径 |
name | 取消订阅主题的消费者的名称。 | 字符串 |
4.3.12.3. 响应 复制链接链接已复制到粘贴板!
HTTP 代码 | 描述 | 模式 |
---|---|---|
204 | 消费者成功取消订阅。 | 无内容 |
404 | 未找到指定的消费者实例。 |
4.3.12.4. Tags 复制链接链接已复制到粘贴板!
- 消费者
4.3.12.5. HTTP 响应示例 复制链接链接已复制到粘贴板!
4.3.12.5.1. 响应 404 复制链接链接已复制到粘贴板!
{ "error_code" : 404, "message" : "The specified consumer instance was not found." }
{
"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 代码 | 描述 | 模式 |
---|---|---|
200 | 网桥处于健康状态 | 无内容 |
4.3.14. GET /openapi 复制链接链接已复制到粘贴板!
4.3.14.1. 描述 复制链接链接已复制到粘贴板!
以 JSON 格式检索 OpenAPI v2 规格。
4.3.14.2. 响应 复制链接链接已复制到粘贴板!
HTTP 代码 | 描述 | 模式 |
---|---|---|
200 | JSON 格式的 OpenAPI v2 规格成功检索。 | 字符串 |
4.3.14.3. produces 复制链接链接已复制到粘贴板!
-
application/json
4.3.15. GET /ready 复制链接链接已复制到粘贴板!
4.3.15.1. 描述 复制链接链接已复制到粘贴板!
检查网桥是否已就绪,并可以接受请求。
4.3.15.2. 响应 复制链接链接已复制到粘贴板!
HTTP 代码 | 描述 | 模式 |
---|---|---|
200 | 网桥已就绪 | 无内容 |
4.3.16. GET /topics 复制链接链接已复制到粘贴板!
4.3.16.1. 描述 复制链接链接已复制到粘贴板!
检索所有主题的列表。
4.3.16.2. 响应 复制链接链接已复制到粘贴板!
HTTP 代码 | 描述 | 模式 |
---|---|---|
200 | 主题列表。 | < string > 数字 |
4.3.16.3. produces 复制链接链接已复制到粘贴板!
-
application/vnd.kafka.v2+json
4.3.16.4. Tags 复制链接链接已复制到粘贴板!
- topics
4.3.16.5. HTTP 响应示例 复制链接链接已复制到粘贴板!
4.3.16.5.1. 响应 200 复制链接链接已复制到粘贴板!
[ "topic1", "topic2" ]
[ "topic1", "topic2" ]
4.3.17. POST /topics/{topicname} 复制链接链接已复制到粘贴板!
4.3.17.1. 描述 复制链接链接已复制到粘贴板!
将一个或多个记录发送到给定的主题,可以选择指定分区、密钥或两者。
4.3.17.2. 参数 复制链接链接已复制到粘贴板!
类型 | Name | 描述 | 模式 |
---|---|---|---|
路径 |
topicName | 要向发送记录或检索元数据的主题名称。 | 字符串 |
查询 |
async | 在发送记录时是否立即返回,而不等待元数据。如果指定,则不会返回偏移。默认为false。 | 布尔值 |
Body |
body |
4.3.17.3. 响应 复制链接链接已复制到粘贴板!
HTTP 代码 | 描述 | 模式 |
---|---|---|
200 | 成功发送的记录。 | |
404 | 未找到指定的主题。 | |
422 | 记录列表无效。 |
4.3.17.4. 使用 复制链接链接已复制到粘贴板!
-
application/vnd.kafka.json.v2+json
-
application/vnd.kafka.binary.v2+json
4.3.17.5. produces 复制链接链接已复制到粘贴板!
-
application/vnd.kafka.v2+json
4.3.17.6. Tags 复制链接链接已复制到粘贴板!
- 制作者
- topics
4.3.17.7. HTTP 请求示例 复制链接链接已复制到粘贴板!
4.3.17.7.1. 请求正文 复制链接链接已复制到粘贴板!
4.3.17.8. HTTP 响应示例 复制链接链接已复制到粘贴板!
4.3.17.8.1. 响应 200 复制链接链接已复制到粘贴板!
4.3.17.8.2. 响应 404 复制链接链接已复制到粘贴板!
{ "error_code" : 404, "message" : "The specified topic was not found." }
{
"error_code" : 404,
"message" : "The specified topic was not found."
}
4.3.17.8.3. 响应 422 复制链接链接已复制到粘贴板!
{ "error_code" : 422, "message" : "The record list contains invalid records." }
{
"error_code" : 422,
"message" : "The record list contains invalid records."
}
4.3.18. GET /topics/{topicname} 复制链接链接已复制到粘贴板!
4.3.18.1. 描述 复制链接链接已复制到粘贴板!
检索有关给定主题的元数据。
4.3.18.2. 参数 复制链接链接已复制到粘贴板!
类型 | Name | 描述 | 模式 |
---|---|---|---|
路径 |
topicName | 要向发送记录或检索元数据的主题名称。 | 字符串 |
4.3.18.3. 响应 复制链接链接已复制到粘贴板!
HTTP 代码 | 描述 | 模式 |
---|---|---|
200 | 主题元数据 |
4.3.18.4. produces 复制链接链接已复制到粘贴板!
-
application/vnd.kafka.v2+json
4.3.18.5. Tags 复制链接链接已复制到粘贴板!
- topics
4.3.18.6. HTTP 响应示例 复制链接链接已复制到粘贴板!
4.3.18.6.1. 响应 200 复制链接链接已复制到粘贴板!
4.3.19. GET /topics/{topicname}/partitions 复制链接链接已复制到粘贴板!
4.3.19.1. 描述 复制链接链接已复制到粘贴板!
检索该主题的分区列表。
4.3.19.2. 参数 复制链接链接已复制到粘贴板!
类型 | Name | 描述 | 模式 |
---|---|---|---|
路径 |
topicName | 要向发送记录或检索元数据的主题名称。 | 字符串 |
4.3.19.3. 响应 复制链接链接已复制到粘贴板!
HTTP 代码 | 描述 | 模式 |
---|---|---|
200 | 分区列表 | < PartitionMetadata > array |
404 | 未找到指定的主题。 |
4.3.19.4. produces 复制链接链接已复制到粘贴板!
-
application/vnd.kafka.v2+json
4.3.19.5. Tags 复制链接链接已复制到粘贴板!
- topics
4.3.19.6. HTTP 响应示例 复制链接链接已复制到粘贴板!
4.3.19.6.1. 响应 200 复制链接链接已复制到粘贴板!
4.3.19.6.2. 响应 404 复制链接链接已复制到粘贴板!
{ "error_code" : 404, "message" : "The specified topic was not found." }
{
"error_code" : 404,
"message" : "The specified topic was not found."
}
4.3.20.1. 描述 复制链接链接已复制到粘贴板!
将一个或多个记录发送到给定的主题分区,可以选择指定密钥。
4.3.20.2. 参数 复制链接链接已复制到粘贴板!
类型 | Name | 描述 | 模式 |
---|---|---|---|
路径 |
partitionid | 要向发送记录或从中检索元数据的分区 ID。 | 整数 |
路径 |
topicName | 要向发送记录或检索元数据的主题名称。 | 字符串 |
查询 |
async | 在发送记录时是否立即返回,而不等待元数据。如果指定,则不会返回偏移。默认为false。 | 布尔值 |
Body |
body | 要发送到给定主题分区的记录列表,包括值(必需)和键(可选)。 |
4.3.20.3. 响应 复制链接链接已复制到粘贴板!
HTTP 代码 | 描述 | 模式 |
---|---|---|
200 | 成功发送的记录。 | |
404 | 未找到指定主题分区。 | |
422 | 记录无效。 |
4.3.20.4. 使用 复制链接链接已复制到粘贴板!
-
application/vnd.kafka.json.v2+json
-
application/vnd.kafka.binary.v2+json
4.3.20.5. produces 复制链接链接已复制到粘贴板!
-
application/vnd.kafka.v2+json
4.3.20.6. Tags 复制链接链接已复制到粘贴板!
- 制作者
- topics
4.3.20.7. HTTP 请求示例 复制链接链接已复制到粘贴板!
4.3.20.7.1. 请求正文 复制链接链接已复制到粘贴板!
4.3.20.8. HTTP 响应示例 复制链接链接已复制到粘贴板!
4.3.20.8.1. 响应 200 复制链接链接已复制到粘贴板!
4.3.20.8.2. 响应 404 复制链接链接已复制到粘贴板!
{ "error_code" : 404, "message" : "The specified topic partition was not found." }
{
"error_code" : 404,
"message" : "The specified topic partition was not found."
}
4.3.20.8.3. 响应 422 复制链接链接已复制到粘贴板!
{ "error_code" : 422, "message" : "The record is not valid." }
{
"error_code" : 422,
"message" : "The record is not valid."
}
4.3.21. GET /topics/{topicname}/partitions/{partitionid} 复制链接链接已复制到粘贴板!
4.3.21.1. 描述 复制链接链接已复制到粘贴板!
检索主题分区的分区元数据。
4.3.21.2. 参数 复制链接链接已复制到粘贴板!
类型 | Name | 描述 | 模式 |
---|---|---|---|
路径 |
partitionid | 要向发送记录或从中检索元数据的分区 ID。 | 整数 |
路径 |
topicName | 要向发送记录或检索元数据的主题名称。 | 字符串 |
4.3.21.3. 响应 复制链接链接已复制到粘贴板!
HTTP 代码 | 描述 | 模式 |
---|---|---|
200 | 分区元数据 | |
404 | 未找到指定主题分区。 |
4.3.21.4. produces 复制链接链接已复制到粘贴板!
-
application/vnd.kafka.v2+json
4.3.21.5. Tags 复制链接链接已复制到粘贴板!
- topics
4.3.21.6. HTTP 响应示例 复制链接链接已复制到粘贴板!
4.3.21.6.1. 响应 200 复制链接链接已复制到粘贴板!
4.3.21.6.2. 响应 404 复制链接链接已复制到粘贴板!
{ "error_code" : 404, "message" : "The specified topic partition was not found." }
{
"error_code" : 404,
"message" : "The specified topic partition was not found."
}
4.3.22.1. 描述 复制链接链接已复制到粘贴板!
检索主题分区偏移的摘要。
4.3.22.2. 参数 复制链接链接已复制到粘贴板!
类型 | Name | 描述 | 模式 |
---|---|---|---|
路径 |
partitionid | 分区的 ID。 | 整数 |
路径 |
topicName | 包含分区的主题名称。 | 字符串 |
4.3.22.3. 响应 复制链接链接已复制到粘贴板!
HTTP 代码 | 描述 | 模式 |
---|---|---|
200 | 主题分区偏移的摘要。 | |
404 | 未找到指定主题分区。 |
4.3.22.4. produces 复制链接链接已复制到粘贴板!
-
application/vnd.kafka.v2+json
4.3.22.5. Tags 复制链接链接已复制到粘贴板!
- topics
4.3.22.6. HTTP 响应示例 复制链接链接已复制到粘贴板!
4.3.22.6.1. 响应 200 复制链接链接已复制到粘贴板!
{ "beginning_offset" : 10, "end_offset" : 50 }
{
"beginning_offset" : 10,
"end_offset" : 50
}
4.3.22.6.2. 响应 404 复制链接链接已复制到粘贴板!
{ "error_code" : 404, "message" : "The specified topic partition was not found." }
{
"error_code" : 404,
"message" : "The specified topic partition was not found."
}