OnsMessageTrace - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Operation description

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

You can use this operation to check the consumption status of a message for preliminary troubleshooting when a consumption exception occurs.
This operation is based on the internal offset mechanism of ApsaraMQ for RocketMQ. The results are reliable in most scenarios. However, if you reset offsets or purge messages, the results may be inaccurate.

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

get

Topic

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

Topic

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

None

mq:OnsInstanceBaseInfo

Request parameters

Parameter	Type	Required	Description	Example
Topic	string	Yes	The topic of the message.	test-mq_topic
MsgId	string	Yes	The ID of the message whose trace you want to query. This is the message ID.	1E05791C117818B4AAC23B1BB0CE****
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. Use this ID to troubleshoot issues.	EAE5BE23-37A1-4354-94D6-E44AE17E****
Data	object
MessageTrack	array<object>	The query results.
	object
TrackType	string	The current status. Valid values: CONSUMED: The message was consumed. CONSUMED_BUT_FILTERED: The message was filtered out and not consumed because it did not meet the subscription conditions of the group ID. NOT_CONSUME_YET: The message has not been consumed. NOT_ONLINE: The client is offline. UNKNOWN: An unknown error occurred.	CONSUMED
ConsumerGroup	string	The group ID of the consumer that subscribes to the topic.	GID_test_group_id
InstanceId	string	The ID of the instance to which the message belongs.	MQ_INST_111111111111_DOxxxxxx

Examples

Success response

JSON format

{
  "RequestId": "EAE5BE23-37A1-4354-94D6-E44AE17E****",
  "Data": {
    "MessageTrack": [
      {
        "TrackType": "CONSUMED",
        "ConsumerGroup": "GID_test_group_id",
        "InstanceId": "MQ_INST_111111111111_DOxxxxxx"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.