DescribeConsumedTopics - 查看 Group 订阅的 Topic--消息队列 RocketMQ版-火山引擎

文档中心

立即注册

导航

DescribeConsumedTopics - 查看 Group 订阅的 Topic

最近更新时间：2024.11.18 10:27:31首次发布时间：2023.07.12 16:22:34

调用 DescribeConsumedTopics 接口查看 Group 订阅的 Topic 信息。

使用说明

此接口用于查看指定 Group 订阅的 Topic 信息，包括 Topic 的队列总数、Topic 名称等。

注意事项

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeConsumedTopics	要执行的操作，取值：DescribeConsumedTopics。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
InstanceId	String	是	rocketmq-cnai1f0c29ca****	实例 ID。
GroupId	String	是	Name	根据 Group 的 ID 筛选。支持模糊查询。不指定此参数时，表示查询所有 Group。
PageNumber	Integer	是	1	列表的页码，最小值为 1。
PageSize	Integer	是	10	列表中每一页的条目数量，取值范围为 1~100。
TopicName	String	否	test	Group 订阅的 Topic 名称。未指定此参数时，返回指定 Group 订阅的所有 Topic 信息。
NeedRetryTopic	Boolean	否	true	返回列表中是否包含重试队列。默认值为 false，表示不返回重试队列。

返回参数

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

参数	类型	示例值	描述
ConsumedTopicsInfo	Array of Object	/	符合查询条件的Topic列表。
Total	Integer	1	指定消费组消费的总 Topic 数量。
Accumulation	Long	0	消息堆积量。

请求示例

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-cnai81fd122a63dd",
  "PageNumber":1,
  "PageSize": 10,
  "GroupId": "GID_test"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023050820152206832A954D9CD549370E",
        "Action": "DescribeConsumedTopics",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-shanghai"
    },
    "Result": {
        "Accumulation": 0,
        "ConsumedTopicsInfo": [
            {
                "QueueNum": 8,
                "SubString": "*",
                "TopicName": "test"
            }
        ],
        "Total": 1
    }
}

错误码

公共错误码请参见公共错误码文档。