消息队列 RocketMQ 版查询消费组订阅的主题列表-主题相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： trocket.tencentcloudapi.com 。

根据消费组获取主题列表，Filter参数使用说明如下：

TopicName，主题名称过滤

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeTopicListByGroup。
Version	是	String	公共参数，本接口取值：2023-03-08。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	集群ID 示例值：rmq-72mo3a9o
Offset	否	Integer	查询起始位置示例值：0
Limit	否	Integer	查询结果限制数量示例值：20
ConsumerGroup	否	String	消费组名称示例值：test_group
Filters.N	否	Array of Filter	查询条件列表

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	查询总数注意：此字段可能返回 null，表示取不到有效值。示例值：10
Data	Array of SubscriptionData	主题列表
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询消费组订阅的主题列表

输入示例

POST / HTTP/1.1
Host: trocket.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTopicListByGroup
<公共请求参数>

{
    "InstanceId": "rmq-72mo3a9o",
    "Offset": 0,
    "Limit": 10,
    "ConsumerGroup": "test_group"
}

输出示例

{
    "Response": {
        "RequestId": "fcf7340b-b7b8-48fd-afe2-b061df13a290",
        "TotalCount": 1,
        "Data": [
            {
                "InstanceId": "rmq-72mo3a9o",
                "Topic": "test_topic",
                "TopicType": "NORMAL",
                "TopicQueueNum": 3,
                "ConsumerGroup": "test_group",
                "IsOnline": true,
                "ConsumeType": "PUSH",
                "SubString": "test_tag",
                "ExpressionType": "TAG",
                "Consistency": 0,
                "ConsumerLag": 20,
                "LastUpdateTime": 1736935187759,
                "MaxRetryTimes": 16,
                "ConsumeMessageOrderly": false,
                "MessageModel": "CLUSTERING"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

查询消费组订阅的主题列表

本页目录：