OnsTraceQueryByMsgKey - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Creates a trace query task based on a topic name and a message key and returns the ID of the query task. You must then call the OnsTraceGetResult operation and pass the returned query task ID to retrieve the detailed results of the message trace.

Operation description

Important The OpenAPI provided by Alibaba Cloud is a control plane API used to manage and query resources for Alibaba Cloud services. Use this API for control plane integration only. Do not use OpenAPI in the core data link to send or receive messages. Otherwise, this may introduce threats to the data link.

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

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 to query.	test
MsgKey	string	Yes	The message key of the message to query.	ORDERID_100
BeginTime	integer	Yes	The beginning of the time range to query. The value is a UNIX timestamp in milliseconds.	1570852800000
EndTime	integer	Yes	The end of the time range to query. The value is a UNIX timestamp in milliseconds.	1570968000000
InstanceId	string	No	The ID of the instance to which the topic of 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 that you can use to troubleshoot and locate issues.	F8654231-122A-4DBD-801F-38E35538****
QueryId	string	The ID of the query task. You must call the OnsTraceGetResult operation with this task ID to obtain the detailed results.	272967562652883649157096685****

Examples

Success response

JSON format

{
  "RequestId": "F8654231-122A-4DBD-801F-38E35538****",
  "QueryId": "272967562652883649157096685****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.