Tencent Cloud

Prev Next

请输入关键字

Recent Pages

文档

Download PDF

DescribeCmqQueues

最后更新时间：2023-08-09 14:43:35

下载PDF

1. API Description

Domain name for API request: tdmq.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	No	String	Common Params. This parameter is not required for this API.
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. Note: This field may return null, indicating that no valid values can be obtained.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Enumerating queues (without distinguishing between users)

Input Example

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

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

Output Example

{
    "Response": {
        "TotalCount": 2005,
        "QueueList": [
            {
                "Tags": [],
                "QueueId": "queue-6zs45b15",
                "QueueName": "QTA-5cd25c1e-5c7c-11ea-b510-460d8830b47a",
                "CreateUin": 100002742997,
                "Qps": 5000,
                "Bps": 52428800,
                "MaxDelaySeconds": 3600,
                "MaxMsgHeapNum": 10000000,
                "PollingWaitSeconds": 0,
                "MsgRetentionSeconds": 345600,
                "VisibilityTimeout": 30,
                "MaxMsgSize": 65536,
                "RewindSeconds": 43200,
                "CreateTime": 1583149980,
                "LastModifyTime": 1583149980,
                "Transaction": false,
                "DeadLetterSource": [],
                "DeadLetterPolicy": [],
                "TransactionPolicy": [],
                "ActiveMsgNum": 0,
                "InactiveMsgNum": 0,
                "DelayMsgNum": 0,
                "RewindMsgNum": 0,
                "MinMsgTime": 0
            }
        ],
        "RequestId": "6bab9048-bc14-4142-80c6-3ec119729bed"
    }
}

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

Tencent Cloud CLI 3.0

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.

联系我们

联系我们，为您的业务提供专属服务。

技术支持

如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

7x24 电话支持

tencent cloud

Recent Pages

DescribeCmqQueues

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Enumerating queues (without distinguishing between users)

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？

tencent cloud

注册

登录

Recent Pages

DescribeCmqQueues

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Enumerating queues (without distinguishing between users)

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？