:OnsDLQMessagePageQueryByGroupId

Usage notes

• If you do not know the ID of the dead-letter message that you want to query, you can call this operation to query all dead-letter messages that are sent to a consumer group 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 a long period of time to find the message that you want to query. You can perform the following steps to query dead-letter messages:

  1. Specify the Topic, BeginTime, EndTime, and PageSize parameters to call this operation to create a query task. By default, this operation returns the information about the dead-letter messages on the first page, total number of pages, and task ID.

  2. Specify the task ID and a page number to call this operation again to query the dead-letter 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 when you created the specified query task.

Request limit

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

Authorization

By default, only 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, 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.

Query dead-letter messages in the console

You can also query the dead-letter messages of a consumer group in the Message Queue for Apache RocketMQ console. For more information, see Dead-letter queues.