调用 DescribeGroupsInTopic 接口，查询订阅目标 Topic 的 Consumer Group（消费组） 列表。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | DescribeGroupsInTopic | 要执行的操作，取值：DescribeGroupsInTopic。 |
Version | String | 是 | 2023-06-01 | API的版本，取值：2023-06-01。 |
TopicId | String | 否 | ae0dd**aa57d70fa57b500c | 需要查询的 Topic ID。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
Items | Array of Object | - | 返回的消费组列表。 |
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" }, ...... ] } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。