OnsDLQMessageResendById - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Operation description

Important The OpenAPI provided by Alibaba Cloud is a management API. You can use it to manage and query resources of Alibaba Cloud services. Integrate OpenAPI for management purposes only. Do not use OpenAPI for core data links that send and receive messages. This practice can introduce threats to your data links.

If a dead-letter message that has reached the maximum number of retries fails to be consumed after being resent, a new message with the same message ID is added to the dead-letter queue. You can check the result on the dead-letter queue query page in the console or by calling a management API. The number of times a message with the same message ID appears indicates the number of failed consumption attempts after the message was resent.
A dead-letter message is a message that failed to be consumed after multiple retries. This usually indicates an issue with the consumption logic. You must identify the cause of the repeated consumption failures before you call this operation to resend the message.
Message Queue for Apache RocketMQ does not track the status of resent dead-letter messages. Messages that are successfully consumed after being resent are not removed from the dead-letter queue. You must determine whether a message needs to be resent. Avoid resending messages unnecessarily to prevent duplicate consumption.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mq:ResendDLQMessage

get

Group

acs:mq:{#regionId}:{#accountId}:{#GroupName}

Group

acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#GroupName}

None

mq:OnsInstanceBaseInfo

Request parameters

Parameter	Type	Required	Description	Example
MsgId	string	Yes	The ID of the message to query. This is the message ID.	0BC16699343051CD9F1D798E7734****
GroupId	string	Yes	The group ID of the consumer to query.	GID_test_group_id
InstanceId	string	No	The ID of the instance that contains the message to query.	MQ_INST_188077086902****_BXSuW61e

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID. This is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.	D94CC769-4DC3-4690-A868-9D0631B1****
Data	object
MsgId	array	The list of messages that are returned.
	string	The message ID.	0BC16699343051CD9F1D798E7734****

Note

If a message fails to be resent, its message ID is returned.

Examples

Success response

JSON format

{
  "RequestId": "D94CC769-4DC3-4690-A868-9D0631B1****",
  "Data": {
    "MsgId": [
      "0BC16699343051CD9F1D798E7734****"
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.