使用 OnsMessageGetByKey 通过传入 Topic 名称和 Message Key 进行模糊查询,得到符合条件的消息的信息列表。

使用本接口根据 Message Key 查询消息的方式属于模糊查询。由于业务方的 Key 可能不唯一,所以查询结果可能为多条。

本接口用在业务方无法获取 Message ID 的场景,在该场景下的调用步骤如下所示:

1. 调用本接口模糊查询得到 Message ID 列表。

2. 调用 OnsMessageGetByMsgId 接口精确查询。OnsMessageGetByMsgId 接口的详细信息,请参见 OnsMessageGetByMsgId

调试

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

请求参数

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

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

Key String messageKey1

需查询的消息的 Message Key

Topic String test-mq_topic

需查询的消息的 Topic

InstanceId String MQ_INST_111111111111_DOxxxxxx

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

返回数据

名称 类型 示例值 描述
Data

查询结果

OnsRestMessageDo

查询结果

Body String SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv

消息体

BodyCRC Integer 914112295

消息体 CRC 校验值

BornHost String 42.120.***.***:59270

生成该消息的客户端实例

BornTimestamp Long 1570760999721

生成时间戳

InstanceId String MQ_INST_111111111111_DOxxxxxx

实例 ID

MsgId String 1E0578FE110F18B4AAC235C05F2*****

消息 ID,即 Message ID

PropertyList

消息属性列表

MessageProperty

消息属性列表

Name String TAGS

Key名

Value String TagA

ReconsumeTimes Integer 1

消息重试消费的次数

StoreHost String 11.193.***.***:10911

存储该消息的服务器实例

StoreSize Integer 406

消息大小

StoreTimestamp Long 1570760999811

被 Broker 存储的时间戳

Topic String test-mq_topic

消息的 Topic

RequestId String 5DC2A47E-2B31-4722-96C8-FA59C996F0CA

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

示例

请求示例


http(s)://[Endpoint]/?Action=OnsMessageGetByKey
&Key=messageKey1
&Topic=test-mq_topic
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&<公共请求参数>

正常返回示例

XML 格式

<OnsMessageGetByKeyResponse>
  <Data>
        <MsgId>1E0578FE110F18B4AAC235C05F2*****</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>
              <MessageProperty>
                    <Name>RETRY_TOPIC</Name>
                    <Value>MQ_INST_111111111111_DOxxxxxx%test-mq_topic</Value>
              </MessageProperty>
              <MessageProperty>
                    <Name>KEYS</Name>
                    <Value>ORDERID_993</Value>
              </MessageProperty>
              <MessageProperty>
                    <Name>UNIQ_KEY</Name>
                    <Value>1E0578FE110F18B4AAC235C0C84*****</Value>
              </MessageProperty>
              <MessageProperty>
                    <Name>WAIT</Name>
                    <Value>false</Value>
              </MessageProperty>
              <MessageProperty>
                    <Name>TAGS</Name>
                    <Value>TagA</Value>
              </MessageProperty>
              <MessageProperty>
                    <Name>INSTANCE_ID</Name>
                    <Value>MQ_INST_111111111111_DOxxxxxx</Value>
              </MessageProperty>
        </PropertyList>
  </Data>
  <RequestId>A07E3902-B92E-44A6-B6C5-6AA1111111799</RequestId>
</OnsMessageGetByKeyResponse>

JSON 格式

{
	"Data":{
		"BornHost":"42.120.**.**:64646",
		"MsgId":"1E0578FE110F18B4AAC235C05F2*****",
		"StoreTimestamp":1570761026708,
		"StoreHost":"11.220.***.***:10911",
		"BodyCRC":914112295,
		"Body":"SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv",
		"InstanceId":"MQ_INST_111111111111_DOxxxxxx",
		"Topic":"test-mq_topic",
		"BornTimestamp":1570761026630,
		"ReconsumeTimes":1,
		"StoreSize":407,
		"PropertyList":{
			"MessageProperty":[
				{
					"Name":"TRACE_ON",
					"Value":"true"
				},
				{
					"Name":"RETRY_TOPIC",
					"Value":"MQ_INST_111111111111_DOxxxxxx%test-mq_topic"
				},
				{
					"Name":"KEYS",
					"Value":"ORDERID_993"
				},
				{
					"Name":"UNIQ_KEY",
					"Value":"1E0578FE110F18B4AAC235C0C84*****"
				},
				{
					"Name":"WAIT",
					"Value":"false"
				},
				{
					"Name":"TAGS",
					"Value":"TagA"
				},
				{
					"Name":"INSTANCE_ID",
					"Value":"MQ_INST_111111111111_DOxxxxxx"
				}
			]
		}
	},
	"RequestId":"A07E3902-B92E-44A6-B6C5-6AA1111111799"
}

错误码

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