使用 OnsDLQMessageGetById 查询指定 Message ID 的死信消息。查询到的信息包括死信消息的存储时间、消息体、Key 和 Tag 等属性。

根据 Message ID 查询死信消息的方式属于精确查询,查询条件需要的 Message ID 从消息发送成功的 SendResult 中获取,或者从批量查询的接口中获取。

调试

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

请求参数

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

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

GroupId String GID_test_group_id

需查询的消费端 Group ID

MsgId String 0BC16699165C03B925DB8A404E2D****

需查询的消息的 ID,即 Message ID

InstanceId String MQ_INST_111111111111_DOxxxxxx

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

返回数据

名称 类型 示例值 描述
RequestId String A07E3902-B92E-44A6-B6C5-6AA1111111799

为公共参数,每个请求的 ID 都是唯一的

Data Struct

查询结果

Topic String test-mq_topic

消息的 Topic

Body String SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv

消息体

StoreSize Integer 407

消息大小

BornTimestamp Long 1570761026630

被服务端存储的时间戳

BornHost String 42.120.**.**:64646

生成该消息的客户端实例

StoreTimestamp Long 1570761026708

被服务端存储的时间戳

StoreHost String 11.220.***.***:10911

存储该消息的服务器实例

MsgId String 0BC16699165C03B925DB8A404E2D****

消息 ID

BodyCRC Integer 914112295

消息体 CRC 校验值

ReconsumeTimes Integer 1

消息重试消费的次数

InstanceId String MQ_INST_111111111111_DOxxxxxx

实例 ID

PropertyList Array

消息属性列表

Name String TAGS

消息属性。取值说明如下:

  • TRACE_ON:是否有消息轨迹
  • KEYS:消息的 Key 属性
  • TAGS:消息的 Tag 属性
  • INSTANCE_ID:消息所在的实例的 ID

更多概念信息请参见名词解释

Value String TagA

消息属性的值

示例

请求示例

http(s)://[Endpoint]/?Action=OnsDLQMessageGetById
&GroupId=GID_test_group_id
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&MsgId=0BC16699165C03B925DB8A404E2D****
&<公共请求参数>

正常返回示例

JSON 格式

{
  "Data": {
    "MsgId": "0BC16699165C03B925DB8A404E2D****",
    "Body": "SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv",
    "InstanceId": "MQ_INST_111111111111_DOxxxxxx",
    "ReconsumeTimes": 1,
    "BornHost": "42.120.**.**:64646",
    "BodyCRC": 914112295,
    "StoreHost": "11.220.***.***:10911",
    "StoreTimestamp": 1570761026708,
    "BornTimestamp": 1570761026630,
    "Topic": "test-mq_topic",
    "StoreSize": 407,
    "PropertyList": {
      "MessageProperty":[
				{
					"Name":"TRACE_ON",
					"Value":"true"
				}
			]
		}
	},
  "RequestId": "A07E3902-B92E-44A6-B6C5-6AA1111111799"
}

XML 格式

<OnsDLQMessageGetByIdResponse>
  <Data>
        <MsgId>0BC16699165C03B925DB8A404E2D****</MsgId>
        <Body>SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv</Body>
        <InstanceId>MQ_INST_111111111111_DOxxxxxx</InstanceId>
        <ReconsumeTimes>1</ReconsumeTimes>
        <BornHost>42.120.**.**:64646</BornHost>
        <BodyCRC>914112295</BodyCRC>
        <StoreHost>11.220.***.***:10911</StoreHost>
        <StoreTimestamp>1570761026708</StoreTimestamp>
        <BornTimestamp>1570761026630</BornTimestamp>
        <Topic>test-mq_topic</Topic>
        <StoreSize>407</StoreSize>
        <PropertyList>
              <MessageProperty>
                    <Name>TRACE_ON</Name>
                    <Value>true</Value>
              </MessageProperty>
        </PropertyList>
  </Data>
  <RequestId>A07E3902-B92E-44A6-B6C5-6AA1111111799</RequestId>
</OnsDLQMessageGetByIdResponse>

错误码

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