:OnsMessagePageQueryByTopic

Note

• If you do not know the message ID or message key of a message that you want to query, you can call this operation to query all messages that are published to a topic within a specified time range. The results are displayed by page.

• We recommend that you specify a short time range to query messages. If you specify a long time range, a large number of messages are returned. In this case, you need to spend a long period of time to find the message that you want to query. Perform the following steps to query messages:

  1. Specify the Topic, BeginTime, EndTime, and PageSize parameters to query the information about messages in the specified topic. By default, the information about the messages on the first page, total number of pages, and task ID are returned.

  2. Specify the task ID and a page number to call this operation again to query the messages on the specified page. In this query, the BeginTime, EndTime, and PageSize parameters do not take effect. By default, the system uses the values of these parameters that you specified in the request for creating the query task.

Request limit

Each Alibaba Cloud account can call this operation up to 10 times per minute. If the number of requests that you send to call this operation within one minute reaches the request limit, new requests fail. This may interrupt your business. For information about the request limit of each operation, see API request limits.

Authorization

By default, Alibaba Cloud accounts can call this operation. A Resource Access Management (RAM) user can call this operation only after the RAM user is granted the required permissions. The following table describes the permissions that must be granted to a RAM user to call this operation. For information about how to grant permissions, see Policies.

Request parameters

Response parameters

Examples

Sample requests

http(s)://ons.cn-hangzhou.aliyuncs.com/?Action=OnsMessagePageQueryByTopic
&BeginTime=1570723200000
&CurrentPage=2
&EndTime=1570809600000
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&Topic=test-mq_topic
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<OnsMessagePageQueryByTopicResponse>
  <MsgFoundDo>
        <MaxPageCount>400</MaxPageCount>
        <MsgFoundList>
              <OnsRestMessageDo>
                    <MsgId>1E0578FE110F18B4AAC235C05F2*****</MsgId>
                    <InstanceId>MQ_INST_111111111111_DOxxxxxx</InstanceId>
                    <ReconsumeTimes>1</ReconsumeTimes>
                    <BornHost>42.120.***.***:59270</BornHost>
                    <StoreTimestamp>1570760999811</StoreTimestamp>
                    <StoreHost>11.193.***.***:10911</StoreHost>
                    <BodyCRC>914112295</BodyCRC>
                    <Topic>test-mq_topic</Topic>
                    <BornTimestamp>1570760999721</BornTimestamp>
                    <StoreSize>406</StoreSize>
                    <PropertyList>     
                          <MessageProperty>
                                <Name>TAGS</Name>
                                <Value>TagA</Value>
                          </MessageProperty>
                    </PropertyList>
              </OnsRestMessageDo>
        </MsgFoundList>
        <TaskId>0BC1310300002A9F000021E4D7A48346</TaskId>
        <CurrentPage>1</CurrentPage>
  </MsgFoundDo>
  <RequestId>5DC2A47E-2B31-4722-96C8-FA59C9*****</RequestId>
</OnsMessagePageQueryByTopicResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "MsgFoundDo" : {
    "MaxPageCount" : 400,
    "MsgFoundList" : {
      "OnsRestMessageDo" : [ {
        "MsgId" : "1E0578FE110F18B4AAC235C05F2*****",
        "ReconsumeTimes" : 1,
        "BornHost" : "42.120.***.***:59270",
        "StoreTimestamp" : 1570760999811,
        "StoreHost" : "11.193.***.***:10911",
        "BodyCRC" : 914112295,
        "Topic" : "test-mq_topic",
        "BornTimestamp" : 1570760999721,
        "StoreSize" : 406,
        "PropertyList" : {
          "MessageProperty" : [ {
            "Name" : "TAGS",
            "Value" : "TagA"
          } ]
        }
      } ]
    },
    "TaskId" : "0BC1310300002A9F000021E4D7A48346",
    "CurrentPage" : 1
  },
  "RequestId" : "5DC2A47E-2B31-4722-96C8-FA59C9*****"
}

Error codes

For a list of error codes, visit the API Error Center.

View information about messages in the console

In the Message Queue for Apache RocketMQ console, you can view the information about a message. For more information, see Query a message.