You need to enable JavaScript to run this app.
导航
消息队列 Kafka版
  • 文档首页
    • /
  • 消息队列 Kafka版

DescribeConsumedPartitions

最近更新时间：2022.10.18 16:24:27

首次发布时间：2022.04.24 15:56:38

我的收藏

调用 DescribeConsumedPartitions 接口查看消费组订阅的分区信息。

使用说明

  • 此接口的 API Version 为 2018-01-01。
  • 此接口的调用频率限制为 100 次/s，超出频率限制会报错 “AccountFlowLimitExceeded”。

请求参数

参数参数类型是否必选示例值说明
InstanceIdString必选kafka-****x实例 ID。
GroupIdString必选my_group消费组 ID。
TopicNameString必选my_topicTopic 名称。
PageNumberInteger必选1查询消费组的页码。不小于 1。
PageSizeInteger必选10单页查询的个数，取值不小于 1。

FiledName

String

可选

PartitionNumber

排序使用的字段。

  • PartitionNumber：（默认）按照分区编号排序。
  • Accumulation：按照消费堆积量排序。

SortOrder

String

可选

Asc

排序方式，可设置为：

  • Desc：降序
  • Asc：升序

响应参数

参数参数类型说明
TotalInteger消费组消费对应 Topic 的分区总数。
PartitionsList符合查询条件的 Partition 列表。详细说明请参考 ConsumedPartition。

示例

请求示例

POST https://kafka.volcengineapi.com/?Action=DescribeConsumedPartitions&Version=2018-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: kafka.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/kafka/request, SignedHeaders=x-date, Signature=********

{
  "PageNumber": 1,
  "PageSize": 10,
  "InstanceId": "kafka-****x",
  "GroupId": "my_group",
  "TopicName": "my_topic",
  "FiledName": "PartitionNumber",
  "SortOrder": "Asc"
}

响应示例

{
  "ResponseMetadata": {
    "RequestId": "****************",
    "Action": "DescribeConsumedPartitions",
    "Version": "2018-01-01",
    "Service": "kafka",
    "Region": "cn-beijing"
  },
  "Result": {
    "Total": 0,
    "Partitions": [
      {
        "PartitionNumber": 0,
        "ConsumedClient": "",
        "ConsumedOffset": 0,
        "StartOffset": 0,
        "EndOffset": 0,
        "Accumulation": 0
      }
    ]
  }
}