Query message trace - O&M APIs| Alibaba Cloud Documentation Center

This interface is exclusive for MQ Platinum edition users. For more information, go to Platinum Edition Purchase Page.

Description

OnsMessageTrack interface determines if a message with the target MsgId has been consumed.

Usage

MessageTrack interface is usually used for determining if a specified message has been consumed, with the MsgId of a single message as the query criterion. Note that because this interface is implemented based on the internal offset system of MQ, the result is credible in most cases. However, if the user has reset the offset or cleared the messages, then the result can be incorrect.

Request parameters

Name	Type	Required	Description
OnsRegionId	String	Yes	It specifies the region to be queried. The value is obtained through the OnsRegionList interface.
OnsPlatform	String	No	The source of the request, which by default is POP platform.
PreventCache	Long	Yes	It’s used for CSRF verification. Set it to the current system time.
Topic	String	Yes	Topic of the message
MsgId	String	Yes	ID of a message

Response parameters

Name	Type	Description
RequestId	String	A public parameter unique for each request
HelpUrl	String	A help link
Data	List(MessageTrack)	Query result

MessageTrack data structure

Name	Type	Description
ConsumerGroup	String	The name of a consumption cluster
TrackType	String	Current status
ExceptionDesc	String	Exception description

OnsMessageGetByMsgId: precisely queries a message by MsgId

Example

public static void main(String []args) {
          String regionId = "cn-hangzhou";
          String accessKey = "XXXXXXXXXXXXXXXXX";
          String secretKey = "XXXXXXXXXXXXXXXXX";
          String endPointName ="cn-hangzhou";
          String productName ="Ons";
          String domain ="ons.cn-hangzhou.aliyuncs.com";
          /**
          *Select Region based on the region you will access, and set the corresponding access point.
          */
          try {
              DefaultProfile.addEndpoint(endPointName，regionId，productName，domain);
          } catch (ClientException e) {
              e.printStackTrace();
          }
          IClientProfile profile= DefaultProfile.getProfile(regionId，accessKey，secretKey);
          IAcsClient iAcsClient= new DefaultAcsClient(profile);
         OnsMessageTraceRequest request = new OnsMessageTraceRequest();
          /**
          *OnsRegionId refers to the resource of the region of MQ required to be accessed by API.
          *This value must be selected and configured by the list obtained through the OnsRegionList method because OnsRegionId is changing, and cannot be written as a fixed value.
          */
         request.setOnsRegionId("daily");
         request.setPreventCache(System.currentTimeMillis());
         request.setAcceptFormat(FormatType.JSON);
         request.setTopic("MingduanTest");
         request.setMsgId("0A91883700001F90000001BF4723CB3E");
         try {
             OnsMessageTraceResponse response=iAcsClient.getAcsResponse(request);
             List<OnsMessageTraceResponse.MessageTrack> trackList =response.getData();
             for (OnsMessageTraceResponse.MessageTrack track:trackList){
                 System.out.println(track.getConsumerGroup()+"  "+track.getTrackType()+"  "+track.getExceptionDesc());
             }
         } catch (ServerException e) {
             e.printStackTrace();
         } catch (ClientException e) {
             e.printStackTrace();
         }
     }