更新时间:2024-01-30 GMT+08:00
分享

查询Kafka实例Topic详细信息

当前页面API为历史版本API,未来可能停止维护。请使用查询Kafka实例Topic详细信息

URI

GET /v1.0/{project_id}/instances/{instance_id}/manage/topics/{topic}

参数说明如下表所示。

表1 参数说明

参数

类型

必选

说明

project_id

String

项目ID。

instance_id

String

实例ID。

topic

String

topic名称。

请求消息

请求参数

请求示例

响应消息

响应参数

参数说明见表2

表2 响应参数说明

参数

类型

说明

topic

String

topic名称。

partitions

Array of object partitions

分区列表。参数查看表3

group_subscribed

Array of String

订阅该topic的消费组名称列表。

表3 partitions参数说明

参数

类型

说明

partition

Integer

分区ID。

leader

Integer

leader副本所在节点的id。

leo

long

分区leader副本的LEO(Log End Offset)。

hw

long

分区高水位(HW,High Watermark)。

lso

long

分区leader副本的LSO(Log Start Offset)。

last_update_timestamp

long

分区上次写入消息的时间。

replicas

Array of object replicas

副本列表。参数查看表4

表4 replicas参数说明

参数

类型

说明

broker

Integer

副本所在的节点ID。

leader

Boolean

该副本是否为leader。

in_sync

Boolean

该副本是否在ISR副本中。

size

Long

该副本当前日志大小。

lag

Long

该副本当前落后hw的消息数。

响应示例

{
    "topic": "test",
    "partitions": [
        {
            "partition": 0,
            "leader": 2,
            "replicas": [
                {
                    "broker": 2,
                    "leader": true,
                    "in_sync": true,
                    "size": 123971146,
                    "lag": 0
                },
                {
                    "broker": 1,
                    "leader": false,
                    "in_sync": true,
                    "size": 123971146,
                    "lag": 0
                },
                {
                    "broker": 0,
                    "leader": false,
                    "in_sync": true,
                    "size": 123971146,
                    "lag": 0
                }
            ],
            "lso": 0,
            "leo": 13598,
            "hw": 13598,
            "last_update_timestamp": 1571477180985
        },
        {
            "partition": 2,
            "leader": 1,
            "replicas": [
                {
                    "broker": 1,
                    "leader": true,
                    "in_sync": true,
                    "size": 123889531,
                    "lag": 0
                },
                {
                    "broker": 0,
                    "leader": false,
                    "in_sync": true,
                    "size": 123889531,
                    "lag": 0
                },
                {
                    "broker": 2,
                    "leader": false,
                    "in_sync": true,
                    "size": 123889531,
                    "lag": 0
                }
            ],
            "lso": 0,
            "leo": 13601,
            "hw": 13601,
            "last_update_timestamp": 1571477077146
        },
        {
            "partition": 1,
            "leader": 0,
            "replicas": [
                {
                    "broker": 0,
                    "leader": true,
                    "in_sync": true,
                    "size": 127245604,
                    "lag": 0
                },
                {
                    "broker": 2,
                    "leader": false,
                    "in_sync": true,
                    "size": 127245604,
                    "lag": 0
                },
                {
                    "broker": 1,
                    "leader": false,
                    "in_sync": true,
                    "size": 127245604,
                    "lag": 0
                }
            ],
            "lso": 0,
            "leo": 13599,
            "hw": 13599,
            "last_update_timestamp": 1571477172959
        }
    ],
    "group_subscribed": [
        "test-consumer-group"
    ]
}

状态码

查询成功的状态码表5所示,其他响应见表1

表5 状态码

状态码

描述

200

查询成功。

相关文档