OnsTraceQueryByMsgId - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Creates a task to query the trace of a message based on the message ID and the name of the topic in which the message is stored. The task ID is returned.

Operation description

Note API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.

If you want to query the trace of a message based on the message ID, you can call this operation to create a query task. After you obtain the task ID, you can call the OnsTraceGetResult operation to query the details of the message trace based on the task ID.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
mq:QueryTrace	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Topic	string	Yes	The topic that contains the message you want to query.	test
MsgId	string	Yes	The ID of the message that you want to query.	1E05791C117818B4AAC23B1BB0CE****
BeginTime	long	Yes	The beginning of the time range to query. The value of this parameter is a UNIX timestamp in milliseconds.	1570852800000
EndTime	long	Yes	The end of the time range to query. The value of this parameter is a UNIX timestamp in milliseconds.	1570968000000
InstanceId	string	Yes	The ID of the ApsaraMQ for RocketMQ instance that contains the specified topic.	MQ_INST_111111111111_DOxxxxxx

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.	B93332A3-160D-404F-880F-1F8736D1****
QueryId	string	The ID of the query task. You can call the OnsTraceGetResult operation to query the details of the message trace based on the task ID.	272967562652883649157096685****

Examples

Sample success responses

JSONformat

{
  "RequestId": "B93332A3-160D-404F-880F-1F8736D1****",
  "QueryId": "272967562652883649157096685****"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history

Create a task to query a message trace in the console

You can also create a task to query the trace of a message in the ApsaraMQ for RocketMQ console.**** For more information, see Query a message.