tencent cloud

DescribeCmqQueues
Last updated: 2025-11-25 10:54:50
DescribeCmqQueues
Last updated: 2025-11-25 10:54:50

1. API Description

Domain name for API request: tdmq.intl.tencentcloudapi.com.

This API is used to query all CMQ queues.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeCmqQueues.
Version Yes String Common Params. The value used for this API: 2020-02-17.
Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
Offset No Integer Starting position of a queue list to be returned on the current page in case of paginated return. If a value is entered, limit must be specified. If this parameter is left empty, 0 will be used by default.
Limit No Integer The number of queues to be returned per page in case of paginated return. If this parameter is not passed in, 20 will be used by default. Maximum value: 50.
QueueName No String Filter by QueueName
QueueNameList.N No Array of String Filter by CMQ queue name.
IsTagFilter No Boolean For filtering by tag, this parameter must be set to true.
Filters.N No Array of Filter Filter. Currently, you can filter by tag. The tag name must be prefixed with “tag:”, such as “tag: owner”, “tag: environment”, or “tag: business”.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer The number of queues.
QueueList Array of CmqQueue Queue list.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Enumerating Queue (Case-Insensitive User)

Input Example

POST / HTTP/1.1
Host: tdmq.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCmqQueues
<Common request parameters>

{
    "Limit": "1",
    "Offset": "0"
}

Output Example

{
    "Response": {
        "RequestId": "730b0b3e-4c67-4a11-a15b-90e6f7c18402",
        "TotalCount": 1,
        "QueueList": [
            {
                "QueueId": "cmqq-bzgqn83nv",
                "QueueName": "test0829",
                "Qps": 5000,
                "Bps": 52428800,
                "MaxDelaySeconds": 3600,
                "MaxMsgHeapNum": 1000000,
                "PollingWaitSeconds": 3,
                "MsgRetentionSeconds": 7200,
                "VisibilityTimeout": 30,
                "MaxMsgSize": 1048576,
                "RewindSeconds": 0,
                "RetentionSizeInMB": 0,
                "CreateTime": 1724918937000,
                "LastModifyTime": 1724924966000,
                "ActiveMsgNum": 0,
                "InactiveMsgNum": 0,
                "DelayMsgNum": null,
                "RewindMsgNum": null,
                "MinMsgTime": null,
                "MaxUnackedMsgNum": 100000,
                "DeadLetterPolicy": {
                    "DeadLetterQueue": "rmqbroker-nj",
                    "Policy": 0,
                    "MaxTimeToLive": 0,
                    "MaxReceiveCount": 22
                },
                "DeadLetterSource": null,
                "Transaction": null,
                "TransactionPolicy": null,
                "CreateUin": null,
                "Trace": null,
                "Tags": null,
                "TenantId": "cmq-13179472",
                "NamespaceName": "CMQ_QUEUE-test0829",
                "Status": 1,
                "MaxMsgBacklogSize": 10737418240
            }
        ]
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
ResourceUnavailable The resource is unavailable.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback