调用OnsMessagePageQueryByTopic查询Topic内所有消息

接口说明

注意阿里云提供的OpenAPI属于管控类API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖OpenAPI实现，否则可能会导致链路产生风险。

按Topic查询消息的方式属于范围查询，查询结果会通过分页的方式展示给调用方，仅适用于没有任何搜索条件（Message ID和Message Key）的查询场景。
根据Topic查询消息应尽可能缩短查询的时间区间，否则匹配的消息过多，将无法定位问题。调用流程如下所示：
1. 传入Topic、起止时间以及每页的消息数量，进行分页查询。如果有消息，默认返回第一页的消息、总页数和查询任务ID。
2. 根据返回的结果中的查询任务ID，进行后续取消息，取消息时传入查询任务ID以及当前页数。此时输入的起止时间和每页消息数量不生效，默认以第一次查询时输入的参数值为准。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
mq:QueryMessage	Read	Ons acs:mq:{#regionId}:{#accountId}:{#TopicName} Ons acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}	无	无

请求参数

名称	类型	必填	描述	示例值
Topic	string	是	需查询的消息的Topic名称。	test-mq_topic
BeginTime	long	是	查询范围的起始时间戳，单位：毫秒。通过TaskId进行后续取消息时，该参数设置的值不生效，默认以第一次查询时输入的起始时间为准。	1570723200000
EndTime	long	是	查询范围的终止时间戳，单位：毫秒。通过TaskId进行后续取消息时，该参数设置的值不生效，默认以第一次查询时输入的终止时间为准。	1570809600000
TaskId	string	否	查询任务的ID，首次查询不需要输入，后续取消息必须传入，根据前一次的返回结果取出该字段。	0BC1310300002A9F000021E4D7A48346
CurrentPage	integer	是	当前取第几页消息，从1开始递增，最大值为50，取消息时不可超过最大页数。	2
PageSize	integer	否	分页查询，每页最多显示的消息数量，默认是20，最小5条，最多50条。通过TaskId进行后续取消息时，该参数设置的值不生效，默认以第一次查询时输入的每页消息数量为准。	5
InstanceId	string	是	需查询的消息所对应的实例ID。	MQ_INST_111111111111_DOxxxxxx

返回参数

名称	类型	描述	示例值
	object	查询结果。
RequestId	string	公共参数，每个请求的ID都是唯一的，可用于排查和定位问题。	5DC2A47E-2B31-4722-96C8-FA59C9*****
MsgFoundDo	object	查询结果。
CurrentPage	long	当前位于第几页。	1
MsgFoundList	array	当前页的消息集合，该类型与OnsMessageGetByMsgId的返回结果一致。
	object
StoreSize	integer	消息大小。单位：KB。	406
ReconsumeTimes	integer	消息重试消费的次数。	1
StoreTimestamp	long	消息被服务端存储的时间戳，单位：毫秒。	1570760999811
InstanceId	string	实例ID。	MQ_INST_111111111111_DOxxxxxx
MsgId	string	消息ID，即Message ID。	1E0578FE110F18B4AAC235C05F2*****
StoreHost	string	存储该消息的服务器实例。	11.193.*.*:10911
Topic	string	消息的Topic。	test-mq_topic
PropertyList	array	消息属性列表。
	object
Value	string	消息属性的取值。	TagA
Name	string	消息属性。取值说明如下： TRACE_ON：是否有消息轨迹。 KEYS：消息的Key属性。 TAGS：消息的Tag属性。 INSTANCE_ID：消息所在的实例的ID。更多概念信息，请参见名词解释。	TAGS
BornTimestamp	long	消息生成的时间戳，单位：毫秒。	1570760999721
BodyCRC	integer	消息体CRC校验值。	914112295
BornHost	string	生成该消息的客户端实例。	42.120.*.*:59270
MaxPageCount	long	查询结果最大页数。	400
TaskId	string	第一次新建查询时，返回的查询任务ID，用于后续取消息。	0BC1310300002A9F000021E4D7A48346

示例

正常返回示例

JSON格式

{
  "RequestId": "5DC2A47E-2B31-4722-96C8-FA59C9*****",
  "MsgFoundDo": {
    "CurrentPage": 1,
    "MsgFoundList": {
      "OnsRestMessageDo": [
        {
          "StoreSize": 406,
          "ReconsumeTimes": 1,
          "StoreTimestamp": 1570760999811,
          "InstanceId": "MQ_INST_111111111111_DOxxxxxx",
          "MsgId": "1E0578FE110F18B4AAC235C05F2*****",
          "StoreHost": "11.193.***.***:10911",
          "Topic": "test-mq_topic",
          "PropertyList": {
            "MessageProperty": [
              {
                "Value": "TagA",
                "Name": "TAGS"
              }
            ]
          },
          "BornTimestamp": 1570760999721,
          "BodyCRC": 914112295,
          "BornHost": "42.120.***.***:59270"
        }
      ]
    },
    "MaxPageCount": 400,
    "TaskId": "0BC1310300002A9F000021E4D7A48346"
  }
}

错误码

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