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

DescribeConsumerGroups

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

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

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

使用说明

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

请求方法
GET

URI

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

传输协议

HTTPS

URI 请求参数

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

ProjectId

String

c7******

消费组所属的日志项目 ID。

PageNumber

Integer

可选

1

分页查询时的页码。默认为 1,即从第一页数据开始返回。

PageSize

Integer

可选

10

分页大小。默认为 20,最大为 100。

响应参数

参数
参数类型
示例值
说明

ConsumerGroups

Array of ConsumerGroup

/

日志服务消费组列表。详细信息请参考 ConsumerGroup

示例

请求示例

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
        }
    ]
}

错误码

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

InvalidArgument

400

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

参数不合法。

InternalServerError

500

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

服务器内部错误。