OnsDLQMessageGetById - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Queries a specific dead-letter message by its message ID. The returned information includes the storage time, message body, key, and tag.

Operation description

Important Alibaba Cloud OpenAPI is a management API used to manage and query resources for Alibaba Cloud services. Integrate OpenAPI only for management purposes. Do not use OpenAPI for core data links that send and receive messages, because this can introduce threats to the data links.

Querying a dead-letter message by its message ID is a term query. You can obtain the message ID from the SendResult of a successful send operation or from a batch query API call. The query returns attributes of the dead-letter message, such as its storage time, message body, key, and tag.

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:QueryDLQMessage

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.	0BC16699165C03B925DB8A404E2D****
GroupId	string	Yes	The group ID of the consumer.	GID_test_group_id
InstanceId	string	No	The ID of the instance to which the message belongs.	MQ_INST_111111111111_DOxxxxxx

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request. This is a common parameter. Each request has a unique ID.	A07E3902-B92E-44A6-B6C5-6AA111111****
Data	object	The query results.
StoreSize	integer	The message size. Unit: KB.	407
ReconsumeTimes	integer	The number of times the message has been retried.	1
StoreTimestamp	integer	The timestamp when the message was stored on the server-side. Unit: milliseconds.	1570761026708
InstanceId	string	The instance ID.	MQ_INST_111111111111_DOxxxxxx
MsgId	string	The message ID.	0BC16699165C03B925DB8A404E2D****
StoreHost	string	The server instance that stores the message.	11.220.*.*:10911
Topic	string	The topic of the message.	test-mq_topic
PropertyList	object
MessageProperty	array<object>	The list of message attributes.
	object
Value	string	The value of the message attribute.	TagA
Name	string	The message attribute. Valid values: TRACE_ON: Indicates whether a message trace exists. KEYS: The key of the message. TAGS: The tag of the message. INSTANCE_ID: The ID of the instance to which the message belongs. For more information, see Terms.	TAGS
BornTimestamp	integer	The timestamp when the message was generated. Unit: milliseconds.	1570761026630
BodyCRC	integer	The cyclic redundancy check (CRC) value of the message body.	914112295
BornHost	string	The producer instance that generated the message.	42.120..:64646

Examples

Success response

JSON format

{
  "RequestId": "A07E3902-B92E-44A6-B6C5-6AA111111****",
  "Data": {
    "StoreSize": 407,
    "ReconsumeTimes": 1,
    "StoreTimestamp": 1570761026708,
    "InstanceId": "MQ_INST_111111111111_DOxxxxxx",
    "MsgId": "0BC16699165C03B925DB8A404E2D****",
    "StoreHost": "11.220.***.***:10911",
    "Topic": "test-mq_topic",
    "PropertyList": {
      "MessageProperty": [
        {
          "Value": "TagA",
          "Name": "TAGS"
        }
      ]
    },
    "BornTimestamp": 1570761026630,
    "BodyCRC": 914112295,
    "BornHost": "42.120.**.**:64646"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.