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

查询消息

功能介绍

查询消息。

URI

GET /v2/{engine}/{project_id}/instances/{instance_id}/messages

表1 路径参数

参数

是否必选

参数类型

描述

engine

是

String

参数解释：

消息引擎。

约束限制：

不涉及。

取值范围：

  • rocketmq：RocketMQ消息引擎。

  • reliability：RocketMQ消息引擎别称。

默认取值：

不涉及。

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

topic

是

String

参数解释：

主题名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

queue

否

String

参数解释：

队列。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

limit

否

Integer

参数解释：

查询数量。

约束限制：

不涉及。

取值范围：

大于0

默认取值：

10

offset

否

Integer

参数解释：

偏移量。

约束限制：

不涉及。

取值范围：

大于等于0。

默认取值：

0。

key

否

String

参数解释：

消息的key。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

start_time

否

String

参数解释：

开始时间。

约束限制：

不通过msg_id精确查询消息时，此参数必填。

取值范围：

不涉及。

默认取值：

不涉及。

end_time

否

String

参数解释：

结束时间。

约束限制：

不通过msg_id精确查询消息时，此参数必填。

取值范围：

不涉及。

默认取值：

不涉及。

msg_id

否

String

参数解释：

消息ID。

约束限制：

不通过时间范围查询消息时，此参数必填。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

messages

Array of Message objects

参数解释：

消息列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

total

Number

参数解释：

消息总数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表4 Message

参数

参数类型

描述

msg_id

String

参数解释：

消息ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

String

参数解释：

实例ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

topic

String

参数解释：

主题名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

store_timestamp

Number

参数解释：

存储消息的时间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

born_timestamp

Number

参数解释：

产生消息的时间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

reconsume_times

Integer

参数解释：

重试次数。

取值范围：

不涉及。

body

String

参数解释：

消息体。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

body_crc

Number

参数解释：

消息体校验和。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

store_size

Number

参数解释：

存储大小。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

property_list

Array of property_list objects

参数解释：

消息属性列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

born_host

String

参数解释：

产生消息的主机IP。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

store_host

String

参数解释：

存储消息的主机IP。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

queue_id

Integer

参数解释：

队列ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

queue_offset

Integer

参数解释：

在队列中的偏移量。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表5 property_list

参数

参数类型

描述

name

String

参数解释：

属性名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

value

String

参数解释：

属性值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求示例

查询消息。

GET https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/messages?topic={topic}&msg_id=C0A807C9000027740000000000000030

响应示例

状态码：200

查询消息成功。

{
  "messages" : [ {
    "msg_id" : "C0A807C9000027740000000000000030",
    "instance_id" : "11c45539-xxxx-xxxx-xxxx-812c41f61f30",
    "topic" : "topic-test",
    "store_timestamp" : 1648888166319,
    "born_timestamp" : 1648888166275,
    "reconsume_times" : 0,
    "body" : "xxxx",
    "body_crc" : 1932557065,
    "store_size" : 175,
    "property_list" : [ {
      "name" : "KEYS",
      "value" : ""
    }, {
      "name" : "UNIQ_KEY",
      "value" : "7F00000123DC6E0BE85808B037820000"
    }, {
      "name" : "CLUSTER",
      "value" : "DmsCluster"
    }, {
      "name" : "TAGS",
      "value" : ""
    } ],
    "born_host" : "192.168.0.66:50098",
    "store_host" : "192.168.7.201:10100",
    "queue_id" : 2,
    "queue_offset" : 0
  } ],
  "total" : 1
}

状态码

状态码

描述

200

查询消息成功。

错误码

请参见错误码。

父主题： 消息管理