All Products
Search
Document Center

Simple Message Queue (formerly MNS):ListQueue

Last Updated:Mar 06, 2025

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

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.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
mns:ListQueuelist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumlongNo

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
PageSizelongNo

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
QueueNamestringNo

The name of the queue.

demo-queue
Tagarray<object>No

The tags.

objectNo

The tags.

KeystringNo

The tag key.

tag1
ValuestringNo

The tag value.

test

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

06273500-249F-5863-121D-74D51123****
Codelong

The response code.

200
Statusstring

The response status.

Success
Messagestring

The returned message.

operation success
Successboolean

Indicates whether the request was successful.

true
Dataobject

The data returned.

PageNumlong

The page number.

1
PageSizelong

The number of entries per page.

50
Sizelong

The number of entries on the current page.

20
Pageslong

The total number of pages returned.

3
Totallong

The total number of entries.

130
PageDataarray<object>

The data returned on the current page.

pageDataobject

The data entries.

QueueNamestring

The name of the queue.

demo-queue
CreateTimelong

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
LastModifyTimelong

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
DelaySecondslong

The period after which all messages sent to the queue are consumed. Unit: seconds.

30
MaximumMessageSizelong

The maximum length of the message that is sent to the queue. Unit: bytes.

65536
MessageRetentionPeriodlong

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
VisibilityTimeoutlong

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
PollingWaitSecondslong

The maximum duration for which long polling requests are held after the ReceiveMessage operation is called. Unit: seconds.

0
ActiveMessageslong

The total number of messages that are in the Active state in the queue. The value is an approximate number. Default value: 0. We recommend that you do not use the return value and that you call CloudMonitor API operations to query the metric value.

20
InactiveMessageslong

The total number of the messages that are in the Inactive state in the queue. The value is an approximate number. Default value: 0. We recommend that you do not use the return value and that you call CloudMonitor API operations to query the metric value.

0
DelayMessageslong

The total number of the messages that are in the Delayed state in the queue. The value is an approximate number. Default value: 0. We recommend that you do not use the return value and that you call CloudMonitor API operations to query the metric value.

0
LoggingEnabledboolean

Indicates whether the logging feature is enabled. Valid values:

  • True
  • False
True
Tagsarray<object>

The tags added to the resources.

Tagsobject

The tag.

TagKeystring

The tag key.

tag1
TagValuestring

The tag value.

test
DlqPolicyobject

The dead-letter queue policy.

Enabledboolean

Specifies whether to enable the dead-letter message delivery.

true
DeadLetterTargetQueuestring

The queue to which dead-letter messages are delivered.

deadLetterTargetQueue
MaxReceiveCountstring

The maximum number of retries.

3

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": "tag1",
            "TagValue": "test"
          }
        ],
        "DlqPolicy": {
          "Enabled": true,
          "DeadLetterTargetQueue": "deadLetterTargetQueue",
          "MaxReceiveCount": "3"
        }
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2025-02-08The response structure of the API has changedView Change Details
2024-05-27The request parameters of the API has changed. The response structure of the API has changedView Change Details