You need to enable JavaScript to run this app.
导航

OpenKafkaConsumer

最近更新时间2023.11.13 16:31:32

首次发布时间2022.10.12 18:53:39

调用 OpenKafkaConsumer 接口为指定日志主题开启 Kafka 协议消费功能。

使用说明

调用此接口为日志主题开启 Kafka 协议消费功能之后,可以将日志主题作为 Kafka 的 Topic 进行消费,每条日志对应一条 Kafka 消息。通过 Kafka 协议消费日志具体方式和配置请参考通过 Kafka 协议消费日志
此接口调用频率限制为 20 次/s,超出频率限制会报错 ExceedQPSLimit。

说明

  • 消费日志时会产生私网或公网的读流量。价格信息请参考计费指引
  • 关闭 Kafka 协议消费功能 2 分钟后,才能再次开启该功能。

URI

请求方法
PUT

URI

https://tls-{Region}.ivolces.com/OpenKafkaConsumer

传输协议

HTTPS

请求参数

参数
参数类型
是否必选
示例值
说明

TopicId

String

必选

0fdaa6b6-3c9f-424c-8664-fc0d222c****

日志主题 ID。

响应参数


示例

请求示例

PUT https://tls-{Region}.ivolces.com/OpenKafkaConsumer HTTP/1.1
Content-Type: application/json
...
{
    "TopicId":"66********"
}

响应示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{}

错误码

错误码(Code)

HTTP 状态码

错误信息(Message)

说明

InvalidArgument

400

Invalid argument key %s, value %s, please check argument.

参数不合法。

TopicNotExist

404

topic %s does not exist.

日志主题不存在。

ConsumeTopicOperateDisable

400

Please try this operator for consume topic after 2min.

请勿频繁操作,请于 2 分钟后再进行。

InternalServerError

500

We encountered an unexpected server error, please try again later.

服务器内部错误。

更多信息,请参考通用错误码