消息队列 Pulsar 版
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 消息队列 Pulsar 版

获取RocketMQ消费组列表

最近更新时间：2024-03-12 01:53:50

我的收藏

本页目录：

1. 接口描述

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

获取RocketMQ消费组列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeRocketMQGroups。
Version 是 String 公共参数，本接口取值：2020-02-17。
Region 是 String 公共参数，详见产品支持的 地域列表。
ClusterId 是 String 集群ID
示例值：rocketmq-xxxxx
NamespaceId 是 String 命名空间
示例值：prod
Offset 是 Integer 偏移量
示例值：0
Limit 是 Integer 限制条数
示例值：20
FilterTopic 否 String 主题名称，输入此参数可查询该主题下所有的订阅组
示例值：test
FilterGroup 否 String 按消费组名称查询消费组，支持模糊查询
示例值：test
SortedBy 否 String 按照指定字段排序，可选值为tps，accumulative
示例值：tps
SortOrder 否 String 按升序或降序排列，可选值为asc，desc
示例值：asc
FilterOneGroup 否 String 订阅组名称，指定此参数后将只返回该订阅组信息
示例值：test
Types.N 否 Array of String group类型
示例值：["TCP"]

3. 输出参数

参数名称 类型 描述
TotalCount Integer 总数量
示例值：100
Groups Array of RocketMQGroup 订阅组列表
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询订阅组列表

test

输入示例

{
  "ClusterId": "xx",
  "NamespaceId": "xx",
  "Offset": 1,
  "Limit": 1,
  "FilterTopic": "xx",
  "FilterGroup": "xx",
  "SortedBy": "xx",
  "SortOrder": "xx",
  "FilterOneGroup": "xx",
  "Types": [
    "xx"
  ]
}

输出示例

{
    "Response": {
        "RequestId": "1c127300-fcdd-4087-b1d2-fd75a1cefbe4",
        "TotalCount": 1,
        "Groups": [
            {
                "Name": "group-example",
                "ConsumerNum": 0,
                "TotalAccumulative": 0,
                "ConsumptionMode": -1,
                "BroadcastEnabled": false,
                "ReadEnabled": true,
                "RetryPartitionNum": 0,
                "CreateTime": 1621307489000,
                "UpdateTime": 1621307706000,
                "ClientProtocol": "TCP",
                "Remark": "modified",
                "ConsumerType": "",
                "TPS": 0,
                "GroupType": "TCP"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
ResourceInUse 资源被占用。
ResourceNotFound 资源不存在。
ResourceNotFound.Cluster 集群不存在。
ResourceUnavailable 资源不可用。
中国站