Products



Message Queue



Documentation > Message Queue > Consumption Message

Product



Receive Message

Request line

GET {Http Access Point}/v2/messages HTTP/1.1

Request headers parameters

Please refer to sections of Common Parameters and Signature-Algorithm for request common parameters.

Request Parameters

Field Name	Field Type	Required	Description
topic	string	Required
consumerGroupId	string	Required
size	int32	Optional	The Maximum number of messages to be pulled at a time, 0 < size <=32, defaultValue = 32
consumerId	string	Optional	defaultValue = httpProxyId
consumeFromWhere	string	Optional	for the default starting consumption location, the optional values are: HEAD, TAIL, defaultValue = HEAD
filterExpressionType	string	Optional	for the message filter expression type, the current optional value is only TAG
filterExpression	string	Optional	The message filter expression is not filtered by default, if filtering is required, this parameter and filterExpressionType must be put in at the same time
ack	string	Optional	Whether the server will automatically ACK the message when pulling the message. The ACK must be within the time-out period of the message confirmation reception, the optional values are true and false; when is true, the server will automatically ACK the message consumed, when is false, the client is required to ACK the consumed message, with the default value of defaultValue = false

Response Body

Request succeed

Field Name	Field Type	Description
requestId	string	The requestId of this request issued to search the call chain
result	map	The return format is: `{"topicName": " lizhijian-041", "ackIndex": " broker-31", "messages": [{"messageId": " messageId_1", "messageBody": " test-0", "properties": {"TAGS":" world"}}, {"messageId": " messageId_2", "messageBody": " test-2", "properties": {"TAGS":" world"}}]}`

Request fail

Field Name	Field Type	Description
requestId	string	The requestId of this request is used to search the call chain
error	map	Return format will be: `{"code":500,"message":" Topic information query failure","Status":" INTERNAL"}`

Description: For sending and receiving Https messages, the interface is the same as Http, except that the Http access point in the request is required to be replaced with an Https access point.