Updated on 2026-10-29 GMT+08:00

Exporting Dead Letter Messages

Function

This API is used to export dead letter messages.

This API is out-of-date and may not be maintained in the future.

Call Method

For details, see Calling APIs.

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
topic	No	String	Topic name.
msg_id_list	No	Array of strings	Message ID list.
uniq_key_list	No	Array of strings	Unique key list.

Response Parameters

Status code: 200

**Table 3** Response body parameter
Parameter	Type	Description
[Array elements]	Array of Message objects	Definition Message.

**Table 4** Message
Parameter	Type	Description
msg_id	String	Definition Message ID. Range N/A
instance_id	String	Definition Instance ID. Range N/A
topic	String	Definition Topic name. Range N/A
store_timestamp	Number	Definition Time when the message is stored. Range N/A
born_timestamp	Number	Definition Time when the message is generated. Range N/A
reconsume_times	Integer	Definition Number of retries. Range N/A
body	String	Definition Message body. Range N/A
body_crc	Number	Definition Message body checksum. Range N/A
store_size	Number	Definition Storage size. Range N/A
property_list	Array of property_list objects	Definition Message attribute list.
born_host	String	Definition IP address of the host that generates the message. Range N/A
store_host	String	Definition IP address of the host that stores the message. Range N/A
queue_id	Integer	Definition Queue ID. Range N/A
queue_offset	Integer	Definition Offset in the queue. Range N/A

**Table 5** property_list
Parameter	Type	Description
name	String	Definition Property name. Range N/A
value	String	Definition Property value. Range N/A

Example Request

Exporting dead letter messages with the specified message IDs and keys in the topic

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

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

Example Response

Status code: 200

The dead letter messages are exported.

{
  "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
}

Status Code

Status Code	Description
200	The dead letter messages are exported.

Error Code

See Error Codes.

Parent Topic: Message Management