文档中心

云原生消息引擎

Group 管理

DescribeSubscription - 查询订阅分区列表

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

请求说明

请求方式：GET

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

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：DescribeSubscription

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

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

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

TopicId string 必选示例值：51b06****67947549e2d9855fcf77b52

需要查询的 Topic ID。

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

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

需要查询的 Consumer Group 的 ID。

返回参数

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

Items object[] 示例值：\-

Group 订阅 Topic 的分区列表。

Lag long 示例值：50

分区中未被消费的消息条数。

GroupName string 示例值：bmq-cg-1

Consumer Group 的名称。

TopicName string 示例值：bmq-test

Consumer Group 订阅的 Topic 名称。

PartitionId integer 示例值：11

分区编号。

LatestOffset long 示例值：53861

最新消费位点。

CurrentOffset long 示例值：53811

当前消费位点。

请求示例

POST /?Action=DescribeSubscription&Version=2023-06-01&GroupId=25950****901433daa48208d5450cd19&TopicId=51b06****67947549e2d9855fcf77b52 HTTP/1.1​
Host: bmq.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20241112T061729Z​
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": "202411042139162030742062546B****",​
    "Action": "DescribeSubscription",​
    "Version": "2023-06-01",​
    "Service": "bmq",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "Items": [​
      {​
        "Lag": 50,​
        "GroupName": "bmq-cg-1",​
        "TopicName": "bmq-test",​
        "PartitionId": 11,​
        "LatestOffset": 53861,​
        "CurrentOffset": 53861​
      }​
    ]​
  }​
}​

错误码

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

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

这个页面对您有帮助吗？

有用

无用