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

Lists all queues in a specified Alibaba Cloud account. You can retrieve the results in pages.

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

mns:ListQueue

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNum	integer	No	The page number of the results to return. Valid values: 1 to 100,000,000. If the value is less than 1, the system uses 1. If the value is greater than 100,000,000, the system uses 100,000,000.	1
PageSize	integer	No	The number of entries to return on each page. Valid values: 10 to 50. If the value is less than 10, the system uses 10. If the value is greater than 50, the system uses 50.	20
QueueName	string	No	The queue name.	demo-queue
Tag	array<object>	No	A list of resource tags.
	object	No	The value of the tag key.
Key	string	No	The key of the tag.	tag1
Value	string	No	The value of the tag.	test
QueueType	string	No	The type of the queue. Valid values: normal: standard queue fifo: FIFO queue	normal

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	06273500-249F-5863-121D-74D51123****
Code	integer	The response code.	200
Status	string	The status of the response.	Success
Message	string	The response message.	operation success
Success	boolean	Indicates whether the request was successful.	true
Data	object	The response data.
PageNum	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	50
Size	integer	The number of entries on the current page.	20
Pages	integer	The total number of pages.	3
Total	integer	The total number of entries.	130
PageData	array<object>	The entries on the current page.
	array<object>	A data entry.
QueueName	string	The queue name.	demo-queue
CreateTime	integer	The time when the queue was created. This value is a UNIX timestamp that represents the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1250700999
LastModifyTime	integer	The time when the queue properties were last modified. This value is a UNIX timestamp that represents the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1250700999
DelaySeconds	integer	The delay period for all messages that are sent to the queue. A message can be consumed only after the specified delay period. Unit: seconds.	30
MaximumMessageSize	integer	The maximum size of a message body that can be sent to the queue. Unit: bytes.	65536
MessageRetentionPeriod	integer	The maximum time to live for a message in the queue. After the specified period, the message is deleted, regardless of whether it has been consumed. Unit: seconds.	65536
VisibilityTimeout	integer	The period during which a message remains in the Inactive state after it is retrieved from the queue. Valid values: 1 to 43,200. Unit: seconds. Default value: 30.	60
PollingWaitSeconds	integer	The maximum polling wait time for a ReceiveMessage request if the queue is empty. Unit: seconds.	0
ActiveMessages	integer	The total number of active messages in the queue. This is an approximate value. This parameter will default to 0 and is deprecated. Use the CloudMonitor API to obtain this metric.	0
InactiveMessages	integer	The total number of inactive messages in the queue. This is an approximate value. This parameter will default to 0 and is deprecated. Use the CloudMonitor API to obtain this metric.	0
DelayMessages	integer	The total number of delayed messages in the queue. This is an approximate value. This parameter will default to 0 and is deprecated. Use the CloudMonitor API to obtain this metric.	0
LoggingEnabled	boolean	Indicates whether the Log Management feature is enabled. True: Enabled. False: Disabled.	True
Tags	array<object>	A list of resource tags.
	object	The tag value.
TagKey	string	The key of the tag.	tag1
TagValue	string	The value of the tag.	test
DlqPolicy	object	The dead-letter queue policy.
Enabled	boolean	Indicates whether messages can be delivered to a dead-letter queue.	true
DeadLetterTargetQueue	string	The target queue to which dead-letter messages are delivered.	deadLetterTargetQueue
MaxReceiveCount	string	The maximum number of times a message can be delivered.	3
QueueType	string	The type of the queue. Valid values: normal: standard queue fifo: FIFO queue	normal

Examples

Success response

JSON format

{
  "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": 0,
        "InactiveMessages": 0,
        "DelayMessages": 0,
        "LoggingEnabled": true,
        "Tags": [
          {
            "TagKey": "tag1",
            "TagValue": "test"
          }
        ],
        "DlqPolicy": {
          "Enabled": true,
          "DeadLetterTargetQueue": "deadLetterTargetQueue",
          "MaxReceiveCount": "3"
        },
        "QueueType": "normal"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.