Creates a trace query task based on a specified topic name and message ID to obtain the ID of the query task.
Usage notes
If you have recorded the ID of a message and need to query the delivery trace of the message based on the message ID, you can call this operation to create a query task. After the task ID is returned, you can call the OnsTraceGetResult operation to obtain the query results based on the task ID.
QPS limit
The queries-per-minute (QPM) limit on this operation is 30 per user. Throttling is triggered when the number of calls to this operation exceeds this limit. Throttling may affect your business. Therefore, call this operation based on your needs. For more information, see QPS limits.
Authorization information
By default, only Alibaba Cloud accounts can call this operation. Resource Access Management (RAM) users can call this operation only after they are authorized. The following table lists the authorization information of this operation. For more information, see Policies and examples.
| Operation |
Action |
Resource with a namespace |
Resource without a namespace |
|---|---|---|---|
| OnsTraceQueryByMsgId |
mq:QueryTrace |
acs:mq:*:*:{instanceId}%{topic} |
acs:mq:*:*:{topic} |
Request parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| Action | String | Yes | OnsTraceQueryByMsgId | The operation that you want to perform. Set the value to OnsTraceQueryByMsgId. |
| BeginTime | Long | Yes | 1570852800000 | The timestamp that indicates the beginning of the time range to query. Unit: milliseconds. |
| EndTime | Long | Yes | 1570968000000 | The timestamp that indicates the end of the time range to query. Unit: milliseconds. |
| InstanceId | String | Yes | MQ_INST_111111111111_DOxxxxxx | The ID of the Message Queue for Apache RocketMQ instance that corresponds to the message. |
| MsgId | String | Yes | 1E05791C117818B4AAC23B1BB0CE**** | The ID of the message that you want to query. |
| Topic | String | Yes | test | The topic of the message that you want to query. |
Response parameters
| Parameter | Type | Example | Description |
|---|---|---|---|
| QueryId | String | 272967562652883649157096685**** | The ID of the query task. You can call the OnsTraceGetResult operation to query detailed results based on the task ID. |
| RequestId | String | B93332A3-160D-404F-880F-1F8736D1**** | The ID of the request, which is a common parameter. Each request has a unique ID, which facilitates troubleshooting and fault locating. |
Examples
Sample requests
http(s)://ons.cn-hangzhou.aliyuncs.com/?Action=OnsTraceQueryByMsgId
&BeginTime=1570852800000
&EndTime=1570968000000
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&MsgId=1E05791C117818B4AAC23B1BB0CE****
&Topic=test
&<Common request parameters>Sample success responses
XML format
<OnsTraceQueryByMsgIdResponse>
<RequestId>B93332A3-160D-404F-880F-1F8736D1039F</RequestId>
<QueryId>272967562652883649157096685****</QueryId>
</OnsTraceQueryByMsgIdResponse>JSON format
{
"RequestId": "B93332A3-160D-404F-880F-1F8736D1039F",
"QueryId": "272967562652883649157096685****"
}Error codes
For a list of error codes, visit the API Error Center.
Operations in the console
In addition to calling the OnsTraceQueryByMsgId operation, you can create a trace query task in the Message Queue for Apache RocketMQ console. For more information, see Query messages.