Reviewed-by: Ziuzko, Stanislav <stanislav.ziuzko@t-systems.com> Co-authored-by: chenjunjie <chenjunjie@huawei.com> Co-committed-by: chenjunjie <chenjunjie@huawei.com>
9.7 KiB
Resending Dead Letter Messages
Function
This API is used to resend dead letter messages.
URI
POST /v2/{project_id}/rocketmq/instances/{instance_id}/messages/deadletter-resend
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
project_id |
Yes |
String |
Definition Project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
instance_id |
Yes |
String |
Definition Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body. Constraints N/A Range N/A Default Value N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
topic |
No |
String |
Definition Topic name. Constraints N/A Range N/A Default Value N/A |
msg_id_list |
No |
Array of strings |
Definition Message list. Constraints N/A Range N/A Default Value N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
|---|---|---|
resend_results |
Array of resend_results objects |
Definition Result of resending a dead letter message. Constraints N/A Range N/A Default Value N/A |
Parameter |
Type |
Description |
|---|---|---|
msg_id |
String |
Definition Message ID. Constraints N/A Range N/A Default Value N/A |
error_code |
String |
Definition Error code. Constraints N/A Range N/A Default Value N/A |
error_message |
String |
Definition Error message. Constraints N/A Range N/A Default Value N/A |
Example Requests
Resending dead letter messages
POST https://{endpoint}/v2/{project_id}/rocketmq/instances/{instance_id}/messages/deadletter-resend
{
"topic" : "%DLQ%group1",
"msg_id_list" : [ "id1" ]
}
Example Responses
Status code: 200
Dead letter messages resent.
{
"resend_results" : [ {
"msg_id" : "C0A8149E0000277600000000000B6835",
"error_code" : "DMS.00000000",
"error_message" : "Success."
} ]
}
Status Codes
Status Code |
Description |
|---|---|
200 |
Dead letter messages resent. |
Error Codes
See Error Codes.