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

DescribeTopicGroups

最近更新时间2023.07.12 16:22:34

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

调用 DescribeTopiGroups 接口获取 Topic 的 Group 信息。

使用说明

此接口用于查看指定 Topic 的 Group 信息,包括消费模式、订阅模式等。

请求参数

参数

参数类型

是否必选

示例值

说明

InstanceId

String

rocketmq-cnai1f0c29ca****

实例 ID。

PageNumber

Integer

1

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

PageSize

Integer

10

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

TopicName

String

Name

Topic 名称,设置此参数表示根据指定的 Topic 名称进行筛选,支持模糊匹配。

GroupIds

Array of String

["GID_test","GID_test1"]

Group ID,若未指定,表示查看所有 Group 信息。

响应参数

参数

参数类型

示例值

说明

Total

Integer

1

符合查询条件的 Group 总数。

GroupsInfo

Array of BasicGroupInfoForTopic

/

符合查询条件的Group列表。详细信息请参考 BasicGroupInfoForTopic

示例

请求示例

POST /?Action=DescribeTopicGroups&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****",
  "TopicName": "test",
  "PageSize": 10,
  "PageNumber": 1,
  "GroupIds": ["GID_test"]
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20230508195447ADBE665727867A4855CF",
        "Action": "DescribeTopicGroups",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-shanghai"
    },
    "Result": {
        "GroupsInfo": [
            {
                "GroupId": "GID_test",
                "MessageModel": "Clustering",
                "SubString": "*"
            }
        ],
        "Total": 1
    }
}