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

DescribeTopicPartitions

最近更新时间：2024.03.08 11:37:25

首次发布时间：2023.03.30 19:59:26

我的收藏

调用 DescribeTopicPartitions 接口获取 Topic 的 Partition 信息。

使用说明

DescribeTopicPartitions 接口提供分页式的查询功能，供您查看指定 Topic 的分区数量、分区 ISR 状态等信息。

请求参数

参数

参数类型

是否必选

示例值

说明

InstanceId

String

是

kafka-cnngbnntswg1****

实例 ID。

TopicName

String

是

my_topic

Topic 名称。

PageNumber

Integer

是

1

列表的页码，最小值为 1。

PageSize

Integer

是

10

列表中每一页的条目数量，取值范围为 1~100。

PartitionIds

Array of Integer

否

[1,2]

分区编号。若未指定，则返回所有分区的信息。

UnderInsyncOnly

Boolean

否

true

是否只查询存在不同步副本的分区列表，默认值为 false。

  • true：只查询存在不同步副本的分区列表。
  • false：查询全部分区列表。

响应参数

参数

参数类型

示例值

说明

Total

Integer

2

符合查询条件的分区总数。

PartitionsInfo

Array of BasicPartitionInfo

/

符合查询条件的分区列表。详细信息请参考数据结构中的 BasicPartitionInfo 部分。

示例

请求示例

POST /?Action=DescribeTopicPartitions&Version=2022-05-01 HTTP/1.1
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=********

{
  "InstanceId": "kafka-cnngbnntswg1****",
  "TopicName": "my_topic",
  "PageNumber": 1,
  "PageSize": 1
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "2023022720063227B3DCC115F59769D448",
        "Action": "DescribeTopicPartitions",
        "Version": "2022-05-01",
        "Service": "Kafka",
        "Region": "cn-beijing"
    },
    "Result": {
        "PartitionsInfo": [
            {
                "EndOffset": 7774940552,
                "InsyncReplicas": [
                    2,
                    1,
                    0
                ],
                "Leader": 2,
                "MessageCount": 16286430,
                "PartitionId": 0,
                "Replicas": [
                    2,
                    1,
                    0
                ],
                "StartOffset": 7758654122,
                "UnderInsyncReplicas": []
            }
        ],
        "Total": 2
    }
}