文档中心>API 中心

查询cmq全量队列

最近更新时间:2024-09-02 02:17:50

我的收藏

1. 接口描述

接口请求域名: tdmq.tencentcloudapi.com 。

查询cmq全量队列

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCmqQueues。
Version String 公共参数,本接口取值:2020-02-17。
Region String 公共参数,详见产品支持的 地域列表
Offset Integer 分页时本页获取队列列表的起始位置。如果填写了该值,必须也要填写 limit 。该值缺省时,后台取默认值 0
示例值:0
Limit Integer 分页时本页获取队列的个数,如果不传递该参数,则该参数默认为20,最大值为50。
示例值:1
QueueName String 根据QueueName进行过滤
示例值:testqueue
QueueNameList.N Array of String CMQ 队列名称列表过滤
示例值:test
IsTagFilter Boolean 标签过滤查找时,需要设置为 true
示例值:true
Filters.N Array of Filter 过滤器。目前支持按标签过滤,标签的Name需要加前缀“tag:”,例如:tag:负责人、tag:环境、tag:业务
示例值:[{"Name":"tag:aa","Values":["bb"]}]

3. 输出参数

参数名称 类型 描述
TotalCount Integer 数量
示例值:2
QueueList Array of CmqQueue 队列列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:[{"QueueId":"cmqq-bzgqn83n","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-131794","NamespaceName":"CMQ_QUEUE-test0829","Status":1,"MaxMsgBacklogSize":10737418240,"BrokerType":1,"SetType":"SHARED","InstanceId":null}]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 枚举队列(不区分用户)

输入示例

POST / HTTP/1.1
Host: tdmq.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCmqQueues
<公共请求参数>

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

输出示例

{
    "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. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
ResourceUnavailable 资源不可用。