ListQueue - Simple Message Queue (formerly MNS) - Alibaba Cloud Documentation Center

Queries all queues that belong to an Alibaba Cloud account. The queues are displayed by page.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
PageNum	long	No	The page number. Valid values: 1 to 100000000. If you set this parameter to a value smaller than 1, the value of this parameter is 1 by default. If you set this parameter to a value greater than 100000000, the value of this parameter is 100000000 by default.	1
PageSize	long	No	The number of entries per page. Value values: 10 to 50. If you set this parameter to a value smaller than 10, the value of this parameter is 10 by default. If you set this parameter to a value greater than 50, the value of this parameter is 50 by default.	20
QueueName	string	No	The name of the queue.	demo-queue

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	06273500-249F-5863-121D-74D51123****
Code	long	The response code.	200
Status	string	The response status.	Success
Message	string	The returned message.	operation success
Success	boolean	Indicates whether the request was successful.	true
Data	object	The returned data.
PageNum	long	The page number.	1
PageSize	long	The number of entries per page.	50
Size	long	The number of entries on the current page.	20
Pages	long	The total number of pages returned.	3
Total	long	The total number of entries.	130
PageData	array<object>	The data returned on the current page.
	object
QueueName	string	The name of the queue.	demo-queue
CreateTime	long	The time when the queue was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1250700999
LastModifyTime	long	The time when the queue was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1250700999
DelaySeconds	long	The period after which all messages sent to the queue are consumed. Unit: seconds.	30
MaximumMessageSize	long	The maximum length of the message that is sent to the queue. Unit: bytes.	65536
MessageRetentionPeriod	long	The maximum duration for which a message is retained in the queue. After the specified retention period ends, the message is deleted regardless of whether the message is received. Unit: seconds.	65536
VisibilityTimeout	long	The duration for which a message stays in the Inactive state after the message is received from the queue. Valid values: 1 to 43200. Unit: seconds. Default value: 30.	60
PollingWaitSeconds	long	The maximum duration for which long polling requests are held after the ReceiveMessage operation is called. Unit: seconds.	0
ActiveMessages	long	The total number of messages that are in the Active state in the queue. The value is an approximate number.	20
InactiveMessages	long	The total number of the messages that are in the Inactive state in the queue. The value is an approximate number.	0
DelayMessages	long	The total number of the messages that are in the Delayed state in the queue. The value is an approximate number.	0
LoggingEnabled	boolean	Indicates whether the logging feature is enabled. Valid values: True False	True

Examples

Sample success responses

JSONformat

{
  "RequestId": "06273500-249F-5863-121D-74D51123****",
  "Code": 200,
  "Status": "Success",
  "Message": "operation success",
  "Success": true,
  "Data": {
    "PageNum": 1,
    "PageSize": 50,
    "Size": 20,
    "Pages": 3,
    "Total": 130,
    "PageData": [
      {
        "QueueName": "demo-queue",
        "CreateTime": 1250700999,
        "LastModifyTime": 1250700999,
        "DelaySeconds": 30,
        "MaximumMessageSize": 65536,
        "MessageRetentionPeriod": 65536,
        "VisibilityTimeout": 60,
        "PollingWaitSeconds": 0,
        "ActiveMessages": 20,
        "InactiveMessages": 0,
        "DelayMessages": 0,
        "LoggingEnabled": true,
        "Tags": [
          {
            "TagKey": "",
            "TagValue": ""
          }
        ]
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-05-27	The request parameters of the API has changed. The response structure of the API has changed	View Change Details