根据指定的 Message Key，查询消息，该查询方式属于模糊查询。由于业务方的 Key 可能不唯一，所以查询结果可能为多条。

调试

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

请求参数

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

系统规定参数。取值：QueryMqSofamqMessageByKey。
Cell String 是 RZ01A

需查询的消息所在的单元
InstanceId String 是 MQ_INST_111111111111_DOxxxxxx

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

需查询的消息的 Message Key
Topic String 是 test-mq_topic

需查询的消息的 Topic

返回数据

名称 类型 示例值 描述
Data 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
RequestId String 861E6630-AEC0-4B2D-B214-6CB5E44B7F04

请求ID
ResultCode String OK

结果码
ResultMessage String OK

结果描述

示例

请求示例

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

正常返回示例

XML 格式

<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>
<Data>
    <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>
</Data>
<Data>
    <PropertyList>
        <Value>TagA</Value>
        <Name>TAGS</Name>
    </PropertyList>
</Data>
<ResultMessage>OK</ResultMessage>
<ResultCode>OK</ResultCode>

JSON 格式

{"RequestId":"861E6630-AEC0-4B2D-B214-6CB5E44B7F04","Data":[{"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"}]}],"ResultMessage":"OK","ResultCode":"OK"}

错误码

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