文档首页/ 分布式消息服务RocketMQ版/ API参考（联盟区域）/ API V2（推荐）/ Topic管理/ 查询单个主题
更新时间：2026-04-03 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询单个主题

功能介绍

查询单个主题。

URI

GET /v2/{project_id}/instances/{instance_id}/topics/{topic}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

topic

是

String

参数解释：

主题名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

name

String

参数解释：

Topic名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

total_read_queue_num

Number

参数解释：

总读队列个数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

total_write_queue_num

Number

参数解释：

总写队列个数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

permission

String

参数解释：

权限。

约束限制：

不涉及。

取值范围：

  • sub：拥有订阅权限。

  • pub：拥有发布权限。

  • all：拥有发布、订阅权限。

默认取值：

不涉及。

created_at

String

参数解释：

创建时间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

brokers

Array of brokers objects

参数解释：

关联的代理。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

message_type

String

参数解释：

消息类型（RocketMQ实例5.x版本才包含此参数）。

约束限制：

不涉及。

取值范围：

  • NORMAL：普通消息。

  • FIFO：顺序消息。

  • DELAY：定时消息。

  • TRANSACTION：事务消息。

默认取值：

不涉及。
表3 brokers

参数

参数类型

描述

broker_name

String

参数解释：

代理名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

read_queue_num

Number

参数解释：

读队列个数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

write_queue_num

Number

参数解释：

写队列个数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求示例

查询指定的单个主题的详细信息。

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

响应示例

状态码：200

查询单个主题成功。

{
  "name" : "topic",
  "total_read_queue_num" : 3,
  "total_write_queue_num" : 3,
  "permission" : "all",
  "brokers" : [ {
    "broker_name" : "broker-0",
    "read_queue_num" : 3,
    "write_queue_num" : 3
  } ],
  "message_type" : "NORMAL"
}

状态码

状态码

描述

200

查询单个主题成功。

错误码

请参见错误码。

父主题： Topic管理