文档首页/ 分布式消息服务Kafka版/ API参考/ API V2（推荐）/ 主题管理/ 获取Kafka Topic详细信息 - ShowKafkaTopicDetail
更新时间：2025-11-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取Kafka Topic详细信息 - ShowKafkaTopicDetail

功能介绍

获取Kafka Topic详细信息。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v2/kafka/{project_id}/instances/{instance_id}/topics-detail/{topic}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，获取方式请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。获取方法如下：调用“查询所有实例列表”接口，从响应体中获取实例ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

topic

是

String

参数解释：

Topic名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

topic

String

参数解释：

Topic名称。

取值范围：

不涉及。

create_time

Long

参数解释：

创建时间。

取值范围：

不涉及。

partitions

Array of partitions objects

参数解释：

分区列表。
表3 partitions

参数

参数类型

描述

partition

Integer

参数解释：

分区编号。

取值范围：

不涉及。

leader

Integer

参数解释：

leader副本所在节点的ID。

取值范围：

不涉及。

replicas

Array of integers

参数解释：

副本列表。

请求示例

GET https://{endpoint}/v2/kafka/{project_id}/instances/{instance_id}/topics-detail/{topic}

响应示例

状态码：200

获取Kafka Topic详细信息成功。

[ {
  "topic" : "topic-test",
  "create_time" : 1763447003740,
  "partitions" : [ {
    "partition" : 0,
    "leader" : 2,
    "replicas" : [ 2 ]
  }, {
    "partition" : 1,
    "leader" : 0,
    "replicas" : [ 0 ]
  }, {
    "partition" : 2,
    "leader" : 1,
    "replicas" : [ 1 ]
  } ]
} ]

状态码

状态码

描述

200

获取Kafka Topic详细信息成功。

错误码

请参见错误码。

父主题： 主题管理

相关文档