tencent cloud

All product documents
APIs
DocumentationAPIsCloud Message QueueAPI 2017Queue ModelQueue APIsGet queue list
Get queue list
Last updated: 2024-12-18 17:45:19
Get queue list
Last updated: 2024-12-18 17:45:19
Note:
This is a legacy API which has been hidden and will no longer be updated. We recommend using the new CMQ API 3.0 which is standardized and faster.

Interface description

This API (ListQueue) is used to list the queues under a user account, and the data can be obtained by page.
Domain name requested by public network API: https://cmq-queue-{$region}.api.qcloud.com
Domain name requested by private network API: http://cmq-queue-{$region}.api.tencentyun.com
The above {$region} in the domain name needs to be replaced with a specific region : gz (Guangzhou), sh (Shanghai), bj (Beijing), shjr (Shanghai Finance), szjr (Shenzhen Finance), hk (Hong Kong, China), cd (Chengdu), ca (North America), usw (American West), sg (Singapore). The region value in the common parameters should be consistent with the region value of the domain name. If there is any inconsistency, the request will be sent to the region specified by the domain name region based on the region value of the domain name.
Note:
At any time (including during internal testing), if the public network downstream Traffic is generated by using a public network domain name, Traffic and cost will be charged. Therefore, it is strongly recommended that users of the service on Tencent Cloud use Private network Domain name, private network will not produce Traffic cost.

Input Parameter

The following request parameter list only lists the API request parameters. For other parameters, please see Common Request Parameters Document.
Parameter name
Required
Type
Description
SearchWord
No
String
Used to filter the queue list, Backend Background uses fuzzy matching to return the list of queues that meet the criteria. If this parameter is left empty, all queues under the account will be returned by default.
Offset
No
Int
This page gets the starting position of the queue list when paging. If Enter reaches this value, Enter limit must also be required. When this value defaults, Backend Background takes the default value of 0
Limit
No
Int
This page gets the number of queues when paging. If this parameter is not passed, the parameter defaults to 20 and the maximum value is 50.

Output Parameter

Parameter name
Type
Description
Code
Int
Please see Error Codes
Message
String
Error message.
RequestId
String
Request ID generated by the server. When an internal error occurs on the server, the user can submit this ID to Backend Background to locate the problem.
TotalCount
Int
The total number of queues returned by this request under the user account, rather than the number of queues obtained on this page after paging
QueueList
Array
Queue list information, each element represents the information of a queue
QueueList is defined as follows:
Parameter name
Type
Description
QueueId
String
Unique identification ID of the queue
QueueName
String
Queue name, which is unique under the same account in a single region. The queue name is a string of no more than 64 characters, must begin with a letter, and the rest can contain letters, numbers, and dashes -## Example
Enter:
Https://domain/v2/index.php?Action=ListQueue & searchWord=test & <Common Request Parameters>
Output:
{
    "code": 0,
    "message": "",
    "requestId": "14534664555",
    "totalCount": 10,
    "queueList": [{
            "queueId": "queue-asdfo",
            "queueName": "test-queue1"
        },
        {
            "queueId": "queue-asdsafo",
            "queueName": "queue-test1"
        }
    ]
}

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 available.

Submit a Ticket
7x24 Phone Support