All Products
Search
Document Center

ListQueue

Last Updated: Jul 23, 2019

Description

This interface is used to list the message queues under the AccountId. Data can be acquired by page. Only the QueueURL attribute is returned.

If necessary, use the GetQueueAttributes interface (see “GetQueueAttributes Interface”) to acquire more message queue attributes.

To acquire the list of specified message queues, specify the ‘x-mns-prefix’ parameter when calling this interface. All message queues with the specified prefix will be returned.

Tip: If the total number of message queues returned for this request exceeds the x-mns-ret-number value, the NextMarker indicating the start position of the next page could be found in the returned XML result, and could be assigned to the x-mns-marker parameter in the next request to fetch the next page.

Request

A request mainly includes the following parts:

  • Request line

    GET /queues HTTP/1.1

  • Special Request Header

Parameter Name Description Required?
x-mns-marker Start position of the next page, which is generally acquired from NextMarker returned in the previous page. Optional
x-mns-ret-number Maximum number of results returned for a single request, which can be an integer between 1 and 1000. The default value is 1000. Optional
x-mns-prefix Search for the queueNames starting with this prefix. Optional

For other request headers, see “Public Request Headers”.

  • Request Body

    None.

Response

The returned message includes 3 parts: returned status line, HTTP header, and message body.

  • HTTP Status Code

    HTTP/1.1 200 OK

  • Special Response Header

    None. See “Public Return Headers”.

  • Response Body

    The result in XML format is returned. The top-layer element Queues contains multiple Queue elements, and the Queue elements contain QueueURL elements. QueueURL indicates the URL address of the created queue.If the number of return results exceeds the x-mns-ret-number value, the element containing NextMarker indicates the start position of the next page.

Special Error

This operation has no special errors and involves mainly permission verification errors and parameter setting errors. For details, refer to MNS error response codes.

Request example:

  1. GET /queues HTTP/1.1
  2. x-mns-marker: xxxx
  3. x-mns-ret-number:2
  4. Host: $AccountId.mns.cn-hangzhou.aliyuncs.com
  5. Date: Wed, 08 Mar 2012 12:00:00 GMT
  6. x-mns-version: 2015-06-06
  7. Authorization: MNS 15B4D3461F177624206A:xQE0diMbLRepdf3YB+FIEXAMPLE=

Return example:

  1. HTTP/1.1 200OK
  2. x-mns-request-id:512B2A634403E52B1956133E
  3. x-mns-version: 2015-06-06
  4. <?xml version="1.0" encoding=”UTF-8 ?>
  5. <Queuesxmlns=”http://mns.aliyuncs.com/doc/v1/”>
  6. <Queue>
  7. < QueueURL>
  8. http:// $AccountId.mns.cn-hangzhou.aliyuncs.com/queues/queueName
  9. </ QueueURL>
  10. </Queue>
  11. <Queue>
  12. < QueueURL>
  13. http:// $AccountId.mns.cn-hangzhou.aliyuncs.com/queues/queueName1
  14. </ QueueURL>
  15. </Queue>
  16. <NextMarker> Base64 Encoded Result </NextMarker>
  17. </Queues>