ListMessages - 查询消息列表 - 云消息队列 RocketMQ 版

查询消息列表。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
rocketmq:ListMessages	list	*Topic `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}`	无	无

请求语法

GET /instances/{instanceId}/topics/{topicName}/messages HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
instanceId	string	是	实例 ID。	rmq-cn-zvp2vtypu05
topicName	string	是	主题名称。	test_delay_queue
messageId	string	否	消息 ID。	7F00000100207A4F0F294A938F7807AE
messageKey	string	否	消息 key。	XSCBillResult
startTime	string	否	查询时间范围：开始时间。	2024-09-09 08:00:00
endTime	string	否	查询时间范围：结束时间	2024-09-09 09:00:00
pageNumber	integer	否	当前页码，从 1 开始。	1
pageSize	integer	否	分页大小，每页最多显示的返回结果数量。	10
scrollId	string	否	请求滚动 ID。第一页请求无需传递，后续分页请求根据第一页返回结果，带上该字段。	B13D0B07-F24B-4790-88D8-D47A38063D00

返回参数

名称	类型	描述	示例值
	object	返回结果
requestId	string	请求 ID	A3531B6A-5A88-52BD-B3C4-A024C3D0AA2E
success	boolean	是否成功	true
data	object	返回结果
pageNumber	long	当前页码	1
pageSize	long	分页大小	50
totalCount	long	总记录数	0
list	array<object>	分页数据
list	object	消息信息
regionId	string	区域 ID	cn-hangzhou
instanceId	string	实例 ID	rmq-cn-7e22ody****
topicName	string	主题名称	topic_test
messageId	string	消息 ID	7F000001000114B4340C5ABF94500079
bornTime	string	生成时间	2023-03-22 12:17:08
storeTime	string	存储时间	2023-03-22 12:17:08
body	string	消息体	{}
bodySize	integer	消息体大小。	100
bornHost	string	消息生产客户端	xx.xx.xx.xx
storeHost	string	消息存储服务端	xx.xx.xx.xx
messageType	string	消息类型	NORMAL
messageTag	string	消息标签	xx
messageGroup	string	消息分组，顺序消息独有。	xx
messageKeys	array	业务标识
messageKey	string	业务标识。	xx
userProperties	object	用户属性
	string	用户属性。	xx
scrollId	string	请求滚动 ID。系统自动生成，后续分页请求需要带上该返回结果，才能持续分页。	B13D0B07-F24B-4790-88D8-D47A38063D00
code	string	错误码	MissingInstanceId
message	string	错误信息	Parameter instanceId is mandatory for this action .
httpStatusCode	integer	HTTP 状态码	200
dynamicCode	string	动态错误码	InstanceId
dynamicMessage	string	动态错误信息	instanceId

示例

正常返回示例

JSON格式

{
  "requestId": "A3531B6A-5A88-52BD-B3C4-A024C3D0AA2E",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 50,
    "totalCount": 0,
    "list": [
      {
        "regionId": "cn-hangzhou",
        "instanceId": "rmq-cn-7e22ody****",
        "topicName": "topic_test",
        "messageId": "7F000001000114B4340C5ABF94500079",
        "bornTime": "2023-03-22 12:17:08",
        "storeTime": "2023-03-22 12:17:08",
        "body": "{}",
        "bodySize": 100,
        "bornHost": "xx.xx.xx.xx",
        "storeHost": "xx.xx.xx.xx",
        "messageType": "NORMAL",
        "messageTag": "xx",
        "messageGroup": "xx",
        "messageKeys": [
          "xx"
        ],
        "userProperties": {
          "key": "xx"
        }
      }
    ],
    "scrollId": "B13D0B07-F24B-4790-88D8-D47A38063D00"
  },
  "code": "MissingInstanceId",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

错误码

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