All Products
Search
Document Center

ApsaraMQ for RocketMQ:OnsTraceQueryByMsgKey

Last Updated:Mar 03, 2024

Creates a message trace query task based on the topic name and message key to obtain the ID of the query task. To obtain the query task details, you must call the OnsTraceGetResult operation and specify the query task ID that is returned by the OnsTraceQueryByMsgKey operation.

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 key that you obtained, 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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
mq:QueryTraceRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TopicstringYes

The topic that contains the message you want to query.

test
MsgKeystringYes

The key of the message that you want to query.

ORDERID_100
BeginTimelongYes

The start of the time range to query. The value of this parameter is a UNIX timestamp in milliseconds.

1570852800000
EndTimelongYes

The end of the time range to query. The value of this parameter is a UNIX timestamp in milliseconds.

1570968000000
InstanceIdstringYes

The ID of the ApsaraMQ for RocketMQ instance that contains the specified topic.

MQ_INST_111111111111_DOxxxxxx

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

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.

F8654231-122A-4DBD-801F-38E35538****
QueryIdstring

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": "F8654231-122A-4DBD-801F-38E35538****",
  "QueryId": "272967562652883649157096685****"
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history

Create a task to query the trace of a message 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.