ListMessages - - Alibaba Cloud Documentation Center

Queries the list of messages.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
rocketmq:ListMessages	list	*Topic `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}`	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	rmq-cn-zvp2vtypu05
topicName	string	Yes	The topic name.	test_delay_queue
messageId	string	No	Message Id.	7F00000100207A4F0F294A938F7807AE
messageKey	string	No	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 page 1.	1
pageSize	integer	No	The number of entries per page.	10
scrollId	string	No	The scroll ID of the request. You do not need to configure this parameter for the first page. This parameter is included in the pagination request based on the result returned for the first page.	B13D0B07-F24B-4790-88D8-D47A38063D00

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
requestId	string	The ID of the request. Each request has a unique ID. You can use this ID to troubleshoot issues.	A3531B6A-5A88-52BD-B3C4-A024C3D0AA2E
success	boolean	Indicates whether the request was successful.	true
data	object	The data returned.
pageNumber	long	The page number.	1
pageSize	long	The number of entries per page.	50
totalCount	long	The total number of returned entries.	0
list	array<object>	The pagination information.
list	object	The message information.
regionId	string	The region ID.	cn-hangzhou
instanceId	string	The instance ID.	rmq-cn-7e22ody****
topicName	string	The name of the topic.	topic_test
messageId	string	Message Id.	7F000001000114B4340C5ABF94500079
bornTime	string	Message born time.	2023-03-22 12:17:08
storeTime	string	Message store time.	2023-03-22 12:17:08
body	string	Message body.	{}
bodySize	integer	Message body size.	100
bornHost	string	The client on which messages are produced.	xx.xx.xx.xx
storeHost	string	The broker on which messages are stored.	xx.xx.xx.xx
messageType	string	Message type.	NORMAL
messageTag	string	The message tag.	xx
messageGroup	string	The message group. This parameter is returned only for ordered messages.	xx
messageKeys	array	Message keys.
messageKey	string	Message key.	xx
userProperties	object	Message user properties.
	string	Message user properties.	xx
scrollId	string	The scroll ID of the request. The ID is automatically generated by the system. The result can be paginated only if this parameter is included in the pagination 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

Sample success responses

JSONformat

{
  "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"
}

Error codes

For a list of error codes, visit the Service error codes.