文档中心

云原生消息引擎

Group 管理

DescribeTopicsInGroup - 查询订阅 Topic 列表

调用 DescribeTopicsInGroup 接口，查询 Consumer Group 订阅的 Topic 列表。

请求说明

请求方式：GET

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

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：DescribeTopicsInGroup

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

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

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

GroupId string 必选示例值：25950****901433daa48208d5450cd19

需要查询的 Consumer Group 的 ID。

返回参数

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

Items object[] 示例值：\-

返回的 Topic 详情。

Lag long 示例值：50

Topic 中未被消费的消息条数。

Status string 示例值：RUNNING

Topic 的状态。

TopicId string 示例值：677bb****b1e406797e87e309785c4e6

Topic ID。

Retention integer 示例值：72

数据在 Topic 中的保留时长，单位为小时。

TopicName string 示例值：bmq-test

Topic 的名称。

CreateTime string 示例值：2024-12-05T17:00:00.061

Topic 的创建时间。

Partitions integer 示例值：12

Topic 分区数。

Description string 示例值：测试使用

Topic 的描述语句。

请求示例

POST /?Action=DescribeTopicsInGroup&Version=2023-06-01&GroupId=25950****901433daa48208d5450cd19 HTTP/1.1​
Host: bmq.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20241112T073044Z​
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": "2024110421231717009913916926****",​
    "Action": "DescribeTopicsInGroup",​
    "Version": "2023-06-01",​
    "Service": "bmq",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "Items": [​
      {​
                "TopicId": "677bb****b1e406797e87e309785c4e6",​
                "TopicName": "bmq-test",​
                "Partitions": 12,​
                "Retention": 72,​
                "Status": "RUNNING",​
                "Description": "测试使用",​
                "Lag": 50,​
                "CreateTime": "2024-12-05T17:00:00.061"​
      }​
    ]​
  }​
}​

错误码

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

状态码	错误码	错误信息	说明
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

这个页面对您有帮助吗？

有用

无用