文档中心

云原生消息引擎

Topic 管理

DescribeGroupsInTopic - 查询订阅消费组列表

调用 DescribeGroupsInTopic 接口，查询订阅目标 Topic 的 Consumer Group（消费组）列表。

请求说明

请求方式：GET

请求地址：https://open.volcengineapi.com?Action=DescribeGroupsInTopic&Version=2023-06-01

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：DescribeGroupsInTopic

要执行的操作，取值：DescribeGroupsInTopic。

Version string 必选示例值：2023-06-01

API的版本，取值：2023-06-01。

TopicId string 可选示例值：ae0dd**aa57d70fa57b500c

需要查询的 Topic ID。

返回参数

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

Items object[] 示例值：\-

返回的消费组列表。

GroupId string 示例值：922a9cb276fe4**c30bc39b199a4

消费组 ID。

GroupName string 示例值：bmq-cg-1

消费组名称。

Description string 示例值：测试使用 CG

消费组描述语句。

请求示例

POST /?Action=DescribeGroupsInTopic&Version=2023-06-01&TopicId=ae0dd**aa57d70fa57b500c HTTP/1.1​
Host: bmq.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20241112T083055Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=AK********/20241112/cn-beijing/bmq/request, SignedHeaders=host;x-content-sha256;x-date, Signature=********​
​
{}​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "202412051853269EC9A478B6D0B841****",​
        "Action": "DescribeGroupsInTopic",​
        "Version": "2023-06-01",​
        "Service": "bmq",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "Items": [​
            {​
                "GroupId": "922a9cb276fe4**c30bc39b199a4",​
                "GroupName": "bmq-cg-1",​
                "Description": "文档测试 CG"​
            },​
            ......​
        ]​
    }​
}​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
200	InvalidParameter	parameter is invalid, pls check parameters	参数值无效。
200	Unauthorized	authorized error	授权错误，请授权或切换账号后重试。
200	InternalServiceError	internal service error, please contact with admin	内部服务错误，请联系技术支持或提交工单。
200	DatabaseError	database error	数据库错误。
200	ParameterEncodingError	Failure encoding object into query map	参数编码异常，请联系技术支持或提交工单。

最近更新时间：2025.08.05 18:34:37

这个页面对您有帮助吗？

有用

无用