文档中心>API 中心

查询cmq队列详情

最近更新时间:2024-10-25 02:16:25

我的收藏

1. 接口描述

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

查询cmq队列详情

默认接口请求频率限制:100次/秒。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCmqQueueDetail。
Version String 公共参数,本接口取值:2020-02-17。
Region String 公共参数,详见产品支持的 地域列表
QueueName String 精确匹配QueueName
示例值:test-queue

3. 输出参数

参数名称 类型 描述
QueueDescribe CmqQueue 队列详情列表。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取cmq队列详情

获取队列详情

输入示例

https://tdmq.tencentcloudapi.com/?Action=DescribeCmqQueueDetail
&QueueName=cmq-xxx
&<公共请求参数>

输出示例

{
    "Response": {
        "QueueDescribe": {
            "QueueId": "abc",
            "QueueName": "abc",
            "Qps": 1,
            "Bps": 1,
            "MaxDelaySeconds": 1,
            "MaxMsgHeapNum": 1,
            "PollingWaitSeconds": 1,
            "MsgRetentionSeconds": 1,
            "VisibilityTimeout": 1,
            "MaxMsgSize": 1,
            "RewindSeconds": 1,
            "CreateTime": 1,
            "LastModifyTime": 1,
            "ActiveMsgNum": 1,
            "InactiveMsgNum": 1,
            "DelayMsgNum": 1,
            "RewindMsgNum": 1,
            "MinMsgTime": 1,
            "Transaction": true,
            "DeadLetterSource": [
                {
                    "QueueId": "abc",
                    "QueueName": "abc"
                }
            ],
            "DeadLetterPolicy": {
                "DeadLetterQueue": "abc",
                "Policy": 1,
                "MaxTimeToLive": 1,
                "MaxReceiveCount": 1
            },
            "TransactionPolicy": {
                "FirstQueryInterval": 1,
                "MaxQueryCount": 1
            },
            "CreateUin": 1,
            "Tags": null,
            "Trace": true,
            "TenantId": "abc",
            "NamespaceName": "abc",
            "Status": 0,
            "MaxUnackedMsgNum": 0,
            "MaxMsgBacklogSize": 0,
            "RetentionSizeInMB": 1
        },
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
ResourceNotFound 资源不存在。