OnsDLQMessagePageQueryByGroupId

Usage notes

• It is a range query to query dead-letter messages based on a group ID. Query results are displayed to the caller by page. You can call this operation only when you do not know a specific message ID.

• We recommend that you minimize the time range to query dead-letter messages. Otherwise, it will be difficult to locate problems due to an excessive number of matched messages. To call this operation, perform the following steps:

  1. Specify the group ID, start time, end time, and number of entries on each page to return. If matched messages are found, the first page of the messages, total number of pages, and query task ID are returned by default.

  2. Query messages that are not displayed on the first page based on the returned query task ID for the first query. When you query the messages, specify the query task ID and current page number. The number of entries to return on each page, the start time, and the end time that you specify for subsequent queries do not take effect. By default, the values that you specified for the first query are used.

QPS limit

The queries-per-second (QPS) limit on this operation is 10 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.

Request parameters

Response parameters

Examples

Sample requests

http(s)://ons.cn-hangzhou.aliyuncs.com/?Action=OnsDLQMessagePageQueryByGroupId
&BeginTime=1570723200000
&CurrentPage=2
&EndTime=1570809600000
&GroupId=GID_test_group_id
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&TaskId=0BC1310300002A9F000021E4D7A48346
&PageSize=5
&<Common request parameters>

Sample success responses

XML format

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

<OnsDLQMessagePageQueryByGroupIdResponse>
    <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>
</OnsDLQMessagePageQueryByGroupIdResponse>

JSON format

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

{
  "OnsDLQMessagePageQueryByGroupIdResponse" : {
    "MsgFoundDo" : {
      "MaxPageCount" : 400,
      "MsgFoundList" : {
        "OnsRestMessageDo" : {
          "MsgId" : "1E0578FE110F18B4AAC235C05F2*****",
          "InstanceId" : "MQ_INST_111111111111_DOxxxxxx",
          "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.

Operations in the Message Queue for Apache RocketMQ console

In addition to calling the OnsDLQMessagePageQueryByGroupId operation, you can query dead-letter messages in the Message Queue for Apache RocketMQ console. For more information, see Dead-letter queues.