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

DescribeKafkaConsumer

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

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

调用 DescribeKafkaConsumer 查看指定日志主题的 Kafka 消费功能状态。

使用说明

此接口调用频率限制为 20 次/s,超出频率限制会报错 ExceedQPSLimit。

URI

请求方法
GET

URI

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

传输协议

HTTPS

URI 请求参数

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

TopicId

String

必选

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

日志主题 ID。

响应参数

参数
参数类型
示例值
说明

AllowConsume

Bool

true

指定日志主题是否已开启了 Kafka 协议消费功能。

  • true:已开启。
  • false:未开启。

ConsumeTopic

String

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

Kafka 协议消费主题 ID,格式为 out+日志主题 ID。通过 Kafka 协议消费此日志主题中的日志数据时,Topic 应指定为此 ID。

示例

请求示例

GET https://tls-{Region}.ivolces.com/DescribeKafkaConsumer?TopicId=fa******** HTTP/1.1

响应示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
    "AllowConsume": true,
    "ConsumeTopic": "out-fa************"
}

错误码

错误码(Code)
HTTP 状态码
错误信息(Message)
说明

InvalidArgument

400

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

参数不合法。

TopicNotExist

404

topic %s does not exist.

日志主题不存在。

InternalServerError

500

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

服务器内部错误。

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