You need to enable JavaScript to run this app.
导航
消息队列 RocketMQ版
  • 文档首页
    • /
  • 消息队列 RocketMQ版

DescribeConsumedTopicDetail

最近更新时间：2024.03.06 16:49:23

首次发布时间：2023.07.12 16:22:34

我的收藏

调用 DescribeConsumedTopics 查看 Group 消费 Topic 的进度。

注意事项

请求频率：该接口请求频率限制为 100 次/秒；单用户请求频率限制为 20 次/秒。

使用说明

此接口用于查看指定 Group 消费指定 Topic 的进度信息，包括各个队列的最大偏移量、当前消费进度等。

请求参数

参数

参数类型

是否必选

示例值

说明

InstanceId

String

是

rocketmq-cnai1f0c29ca****

实例 ID。

GroupId

String

是

GID_test

根据 Group 的 ID 筛选。支持模糊查询。

PageNumber

Integer

是

1

列表的页码，最小值为 1。

PageSize

Integer

是

10

列表中每一页的条目数量，取值范围为 1~100。

TopicName

String

是

test

Group 订阅的 Topic 名称。

响应参数

参数

参数类型

示例值

说明

ConsumedQueueInfo

Array of ConsumedQueueInfoObject

/

Group 订阅的 Topic 中，每个队列的消费进度信息。

Total

Integer

2

符合检索条件的检索结果数量。

示例

请求示例

POST /?Action=DescribeConsumedTopics&Version=2023-01-01 HTTP/1.1
Content-Type: application/json
Host: rocketmq.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-shanghai/rocketmq/request, SignedHeaders=x-date, Signature=********

{
  "InstanceId": "rocketmq-cnai81fd122a****",
  "PageNumber": 1,
  "PageSize": 10,
  "GroupId": "GID_test"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "2023050820182789EC0465AE0A834A31A0",
        "Action": "DescribeConsumedTopicDetail",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-shanghai"
    },
    "Result": {
        "ConsumedQueueInfo": [
            {
                "ConsumeOffset": 300284750,
                "DiffCount": 0,
                "EndOffset": 300284750,
                "LastTimeStamp": 0,
                "QueueId": "rocketmq-cnai81fd122a****-broker-0-6"
            },
            {
                "ConsumeOffset": 300284750,
                "DiffCount": 0,
                "EndOffset": 300284750,
                "LastTimeStamp": 0,
                "QueueId": "rocketmq-cnai81fd122a****-broker-0-3"
            }
        ],
        "Total": 2
    }
}