You need to enable JavaScript to run this app.
导航
DescribeKafkaConsumer
最近更新时间:2024.07.02 18:09:16首次发布时间:2022.10.12 18:53:39
  1. 调用 DescribeKafkaConsumer 查看指定日志主题的 Kafka 消费功能状态。

使用说明

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

请求说明

  • 请求方式:GET
  • 请求地址:https://tls-{Region}.ivolces.com/DescribeKafkaConsumer

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数类型是否必选示例值描述
TopicIdStringc7e0e442-19bf-4fb3-b547-5992fb8b****日志主题 ID。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数类型示例值描述

AllowConsume

Boolean

true

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

  • true:已开启。
  • false:未开启。
ConsumeTopicStringout-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************"
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HTTP 状态码错误码错误信息说明
400InvalidArgumentInvalid argument key %s, value %s, please check argument.参数不合法。
404TopicNotExisttopic %s does not exist.日志主题不存在。
500InternalServerErrorWe encountered an unexpected server error, please try again later.服务器内部错误。