文档首页/ 分布式消息服务RocketMQ版/ API参考/ 历史API/ API V2/ 消息管理/ 导出死信消息
更新时间：2026-01-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

导出死信消息

功能介绍

导出死信消息。

当前页面API为历史版本API，未来可能停止维护。

调用方法

请参见如何调用API。

URI

POST /v2/{project_id}/instances/{instance_id}/messages/export

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

实例ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

topic

否

String

主题名称。

msg_id_list

否

Array of strings

消息ID列表。

uniq_key_list

否

Array of strings

唯一Key列表。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

[数组元素]

Array of Message objects

参数解释：

消息。
表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

参数解释：

属性值。

取值范围：

不涉及。

请求示例

导出主题中指定消息ID和Key的死信消息。

POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/messages/export

{
  "topic" : "%DLQ%group1",
  "msg_id_list" : [ "C0A8011700002774000000000013B19D", "C0A8011700002774000000000013B30F" ],
  "uniq_key_list" : [ "7F000001001C18B4AAC26B8AED170010", "7F000001001C18B4AAC26B8AEE030015" ]
}

响应示例

状态码：200

导出死信消息成功。

{
  "topic" : "topic_01",
  "body" : "Hello world",
  "property_list" : {
    "name" : "ORIGIN_MESSAGE_ID",
    "value" : "C0A8005B00002775000000000000EBAE"
  },
  "msg_id" : "C0A8005B0000277500000000000133A2",
  "instance_id" : "56055acb-3c3b-4481-aeab-10464086c2b4",
  "store_timestamp" : 1662690563020,
  "born_timestamp" : 1662690324415,
  "reconsume_times" : 5,
  "body_crc" : 198614610,
  "store_size" : 317,
  "born_host" : "10.58.233.224:63529",
  "store_host" : "192.168.0.91:10101",
  "queue_id" : 0,
  "queue_offset" : 0
}

状态码

状态码

描述

200

导出死信消息成功。

错误码

请参见错误码。

父主题： 消息管理

相关文档