ListMessages - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Queries a list of messages.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

rocketmq:ListMessages

list

*Topic

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	rmq-cn-zvp2vtypu05
topicName	string	Yes	The topic name.	test_delay_queue

Request parameters

Parameter	Type	Required	Description	Example
messageId	string	No	The message ID.	7F00000100207A4F0F294A938F7807AE
messageKey	string	No	The message key.	XSCBillResult
startTime	string	No	The beginning of the time range to query.	2024-09-09 08:00:00
endTime	string	No	The end of the time range to query.	2024-09-09 09:00:00
pageNumber	integer	No	The page number. Pages start from 1.	1
pageSize	integer	No	The number of entries to return on each page.	10
scrollId	string	No	The scroll ID. Do not specify this parameter for the first request. For subsequent paged queries, set this parameter to the scroll ID returned in the previous response.	B13D0B07-F24B-4790-88D8-D47A38063D00
liteTopicName	string	No	The name of the lightweight topic.	abc

Response elements

Element	Type	Description	Example
	object	The response.
requestId	string	The request ID.	A3531B6A-5A88-52BD-B3C4-A024C3D0AA2E
success	boolean	Indicates whether the request was successful.	true
data	object	The returned data.
pageNumber	integer	The page number of the returned page.	1
pageSize	integer	The number of entries returned per page.	50
totalCount	integer	The total number of records.	0
list	array<object>	The paged data.
	array<object>	The message information.
regionId	string	The region ID.	cn-hangzhou
instanceId	string	The instance ID.	rmq-cn-7e22ody****
topicName	string	The topic name.	topic_test
messageId	string	The message ID.	7F000001000114B4340C5ABF94500079
bornTime	string	The time when the message was created.	2023-03-22 12:17:08
storeTime	string	The time when the message was stored.	2023-03-22 12:17:08
body	string	The message body.	{}
bodySize	integer	The size of the message body.	100
bornHost	string	The client that produced the message.	xx.xx.xx.xx
storeHost	string	The server that stored the message.	xx.xx.xx.xx
messageType	string	The message type.	NORMAL
messageTag	string	The message tag.	xx
messageGroup	string	The message group. This parameter is specific to ordered messages.	xx
messageKeys	array	The business keys.
	string	The business key.	xx
userProperties	object	The user properties.
	string	The user property.	xx
liteTopicName	string	The name of the lightweight topic.	abc
scrollId	string	The scroll ID. The system generates this ID automatically. To retrieve the next page of results, include this ID in the subsequent request.	B13D0B07-F24B-4790-88D8-D47A38063D00
code	string	The error code.	MissingInstanceId
message	string	The error message.	Parameter instanceId is mandatory for this action .
httpStatusCode	integer	The HTTP status code.	200
dynamicCode	string	The dynamic error code.	InstanceId
dynamicMessage	string	The dynamic error message.	instanceId

Examples

Success response

JSON format

{
  "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"
        },
        "liteTopicName": "abc"
      }
    ],
    "scrollId": "B13D0B07-F24B-4790-88D8-D47A38063D00"
  },
  "code": "MissingInstanceId",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.