You need to enable JavaScript to run this app.
导航
日志服务
  • 文档首页
    • /
  • 日志服务

DescribeConsumerGroups

最近更新时间：2024.04.19 13:54:15

首次发布时间：2023.09.27 12:24:24

我的收藏

调用 DescribeConsumerGroups 接口获取一个日志项目下的所有消费组信息。

使用说明

  • 此接口用于查看指定日志项目下的消费组信息列表，支持分页查询、按偏移量查询。
  • 此接口的调用频率限制为 20 次/s，超出频率限制会报错 ExceedQPSLimit。

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
PageNumberInteger否1分页查询时的页码。默认为 1，即从第一页数据开始返回。
PageSizeInteger否10分页大小。默认为 20，最大为 100。
ConsumerGroupNameString否"test-consumergroup"消费组名称。
ProjectIdString否"fa************"消费组所属的日志项目 ID。
ProjectNameString否pt*****消费组所属的日志项目名称。
TopicIdString否"fa************"消费者所属的日志主题 ID。
TopicNameString否消费组所属的日志主题名称。
IamProjectNameString否testIAM 日志项目名称。

返回参数

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

参数类型示例值描述
ConsumerGroupsArray of ConsumerGroupResp{ "ConsumerGroups": [ { "ProjectID": "32********", "ConsumerGroupName": "test-consumer-group", "HeartbeatTTL": 60, "OrderedConsume": false } ] }日志服务消费组列表。
TotalInteger1消费组总数。

ConsumerGroupResp

参数类型示例值描述
topic_idArray of Stringc7******消费组订阅的日志主题列表。
ProjectIDStringc7******消费组订阅的日志项目 ID。
ProjectNameStringtest消费组订阅的日志项目名称。
HeartbeatTTLInteger60心跳过期时间，单位为秒。

OrderedConsume

Boolean

false

是否按顺序消费。

  • true：在 Shard 中按顺序消费。Shard 分裂后，先消费完原 Shard 数据，然后并行消费由该 Shard 分裂出的 Shard 数据；Shard 合并后，先消费完原 Shard 数据，然后消费由原 Shard 合并后的新 Shard 数据。
  • false：不按顺序消费。即所有 Shard 同时消费，Shard 分裂或者合并后产生的新 Shard，也会立即消费。
ConsumerGroupNameStringmy-consumer-group消费组名称。

请求示例

GET https://tls-{Region}.ivolces.com/DescribeConsumerGroups?ProjectId=662***&PageNumber=1&PageSize=10 HTTP/1.1

返回示例

{
    "ConsumerGroups": [
        {
            "ProjectID": "32********",
            "ConsumerGroupName": "test-consumer-group",
            "HeartbeatTTL": 60,
            "OrderedConsume": false
        }
    ]
}

错误码

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

HTTP 状态码错误码错误信息说明
400InvalidArgumentInvalid argument key %s, value %s, please check argument.参数不合法。
500InternalServerErrorWe encountered an unexpected server error, please try again later.服务器内部错误。