通过传入 Group ID 和时间段,分页查询指定时间段内该 Group ID 内的所有死信消息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String QueryMqSofamqDLQMessageByGroupId

系统规定参数。取值:QueryMqSofamqDLQMessageByGroupId。

BeginTime Long 1570723200000

查询范围的起始时间戳

Cell String RZ01A

需要查询的单元

EndTime Long 1570809600000

查询范围的终止时间戳

GroupId String GID_test_group_id

需查询的消费端 Group ID

InstanceId String MQ_INST_111111111111_DOxxxxxx

需查询的消息所对应的实例 ID。针对有独立命名空间的实例,该参数为必填。

PageNum Long 1

页码

PageSize Long 10

每页条数

TaskId String 0BC1310300002A9F000021E4D7A48346

查询任务的 ID。首次查询不需要输入,后续获取消息必须传入,根据前一次的返回结果取出该字段。

返回数据

名称 类型 示例值 描述
Data Struct

消息内容

Content Array

消息的详细信息

Body String SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv

消息体

BodyCrc Long 914112295

消息体 CRC 校验值

BornHost String 42.120..:64646

生成该消息的客户端实例

BornTimestamp Long 1570761026630

生成时间戳

InstanceId String MQ_INST_111111111111_DOxxxxxx

实例 ID

MsgId String 1E0578FE110F18B4AAC235C0C8460BA2

消息 ID,即 Message ID

PropertyList Array

消息属性列表

Name String TAGS

Key 名

Value String TagA

ReconsumeTimes Long 1

消息重试消费的次数

StoreHost String 11.220..:10911

存储该消息的服务器实例

StoreSize Long 407

消息大小

StoreTimestamp Long 1570761026708

被服务端存储的时间戳

Topic String test-mq_topic

消息的 Topic

PageNum Long 1

页码

PageSize Long 10

每页显示条数

TaskId String 0BC1310300002A9F000021E4D7A48346

第一次新建查询时返回的查询任务 ID,用于后续获取消息。

Total Long 100

总页数

RequestId String 861E6630-AEC0-4B2D-B214-6CB5E44B7F04

请求ID

ResultCode String OK

结果码

ResultMessage String OK

结果描述

示例

请求示例

http(s)://[Endpoint]/?Action=QueryMqSofamqDLQMessageByGroupId&BeginTime=1570723200000&Cell=RZ01A&EndTime=1570809600000&GroupId=GID_test_group_id&InstanceId=MQ_INST_111111111111_DOxxxxxx&PageNum=1&PageSize=10&TaskId=0BC1310300002A9F000021E4D7A48346&<公共请求参数>

正常返回示例

XML 格式

<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId><Data>    <TaskId>0BC1310300002A9F000021E4D7A48346</TaskId>    <PageNum>1</PageNum>    <PageSize>10</PageSize>    <Content>        <BornTimestamp>1570761026630</BornTimestamp>        <InstanceId>MQ_INST_111111111111_DOxxxxxx</InstanceId>        <StoreSize>407</StoreSize>        <BornHost>42.120..:64646</BornHost>        <BodyCrc>914112295</BodyCrc>        <Topic>test-mq_topic</Topic>        <Body>SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv</Body>        <ReconsumeTimes>1</ReconsumeTimes>        <MsgId>1E0578FE110F18B4AAC235C0C8460BA2</MsgId>        <StoreHost>11.220..:10911</StoreHost>        <StoreTimestamp>1570761026708</StoreTimestamp>    </Content>    <Content>        <PropertyList>            <Value>TagA</Value>            <Name>TAGS</Name>        </PropertyList>    </Content>    <Total>100</Total></Data><ResultMessage>OK</ResultMessage><ResultCode>OK</ResultCode>

JSON 格式

{“RequestId”:”861E6630-AEC0-4B2D-B214-6CB5E44B7F04”,”Data”:{“TaskId”:”0BC1310300002A9F000021E4D7A48346”,”PageNum”:”1”,”PageSize”:”10”,”Content”:[{“BornTimestamp”:”1570761026630”,”InstanceId”:”MQ_INST_111111111111_DOxxxxxx”,”StoreSize”:”407”,”BornHost”:”42.120..:64646”,”BodyCrc”:”914112295”,”Topic”:”test-mq_topic”,”Body”:”SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv”,”ReconsumeTimes”:”1”,”MsgId”:”1E0578FE110F18B4AAC235C0C8460BA2”,”StoreHost”:”11.220..:10911”,”StoreTimestamp”:”1570761026708”},{“PropertyList”:[{“Value”:”TagA”,”Name”:”TAGS”}]}],”Total”:”100”},”ResultMessage”:”OK”,”ResultCode”:”OK”}

错误码

访问错误中心查看更多错误码。

     </article>
  </main>