API 中心
有奖：语音产品征文挑战赛火热进行中> HOT
文档中心 > API 中心

查询RabbitMQ队列详情

最近更新时间：2024-05-09 01:24:33

我的收藏

本页目录：

1. 接口描述

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

查询RabbitMQ队列详情

默认接口请求频率限制：20次/秒。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeRabbitMQQueueDetail。
Version 是 String 公共参数，本接口取值：2020-02-17。
Region 是 String 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: 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 。
InstanceId 是 String 实例Id
示例值：amqp-xxx
VirtualHost 是 String Vhost参数
示例值：testVhost
QueueName 是 String 队列名称
示例值：testQueue

3. 输出参数

参数名称 类型 描述
InstanceId String 队列名称
注意：此字段可能返回 null，表示取不到有效值。
示例值：queue1
VirtualHost String Vhost参数
注意：此字段可能返回 null，表示取不到有效值。
示例值：testVhost
QueueName String 队列名称
注意：此字段可能返回 null，表示取不到有效值。
示例值：testQueue
QueueType String 队列类型,取值classic或quorum
注意：此字段可能返回 null，表示取不到有效值。
示例值：classic
Consumers Integer 在线消费者数量
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
Durable Boolean 持久标记
注意：此字段可能返回 null，表示取不到有效值。
示例值：true
AutoDelete Boolean 自动清除
注意：此字段可能返回 null，表示取不到有效值。
示例值：false
Remark String 备注
注意：此字段可能返回 null，表示取不到有效值。
示例值：testRemark
MessageTTL Integer MessageTTL参数,classic类型专用
注意：此字段可能返回 null，表示取不到有效值。
示例值：1000
AutoExpire Integer AutoExpire参数
注意：此字段可能返回 null，表示取不到有效值。
示例值：1000
MaxLength Integer MaxLength参数
注意：此字段可能返回 null，表示取不到有效值。
示例值：1000
MaxLengthBytes Integer MaxLengthBytes参数
注意：此字段可能返回 null，表示取不到有效值。
示例值：1000
DeliveryLimit Integer DeliveryLimit参数,quorum类型专用
注意：此字段可能返回 null，表示取不到有效值。
示例值：1000
OverflowBehaviour String OverflowBehaviour参数,取值为drop-head, reject-publish或reject-publish-dlx
注意：此字段可能返回 null，表示取不到有效值。
示例值：drop-head
DeadLetterExchange String DeadLetterExchange参数
注意：此字段可能返回 null，表示取不到有效值。
示例值：testDeadLetterExchange
DeadLetterRoutingKey String DeadLetterRoutingKey参数
注意：此字段可能返回 null，表示取不到有效值。
示例值：testDeadLetterRoutingKey
SingleActiveConsumer Boolean SingleActiveConsumer参数
注意：此字段可能返回 null，表示取不到有效值。
示例值：true
MaximumPriority Integer MaximumPriority参数,classic类型专用
注意：此字段可能返回 null，表示取不到有效值。
示例值：1000
LazyMode Boolean LazyMode参数,classic类型专用
注意：此字段可能返回 null，表示取不到有效值。
示例值：true
MasterLocator String MasterLocator参数,classic类型专用
注意：此字段可能返回 null，表示取不到有效值。
示例值：testMasterLocator
MaxInMemoryLength Integer MaxInMemoryLength参数,quorum类型专用
注意：此字段可能返回 null，表示取不到有效值。
示例值：1000
MaxInMemoryBytes Integer MaxInMemoryBytes参数,quorum类型专用
注意：此字段可能返回 null，表示取不到有效值。
示例值：1000
CreateTime Integer 创建时间戳,单位秒
注意：此字段可能返回 null，表示取不到有效值。
示例值：1669174535
Node String 节点
注意：此字段可能返回 null，表示取不到有效值。
示例值：rabbit@rabbitmq-broker-0.rabbitmq-broker-internal.amqp-xxx.
DeadLetterStrategy String 仲裁队列死信一致性策略
注意：此字段可能返回 null，表示取不到有效值。
示例值：at-most-once
QueueLeaderLocator String 仲裁队列的领导者选举策略
注意：此字段可能返回 null，表示取不到有效值。
示例值：client-local
QuorumInitialGroupSize Integer 仲裁队列的初始副本组大小
注意：此字段可能返回 null，表示取不到有效值。
示例值：3
Exclusive Boolean 是否为独占队列
注意：此字段可能返回 null，表示取不到有效值。
示例值：true
Policy String 生效的策略名
注意：此字段可能返回 null，表示取不到有效值。
示例值：test-policy
Arguments String 扩展参数 key-value
注意：此字段可能返回 null，表示取不到有效值。
示例值：{}
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询RabbitMQ队列详情

输入示例

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

{
    "InstanceId": "abc",
    "VirtualHost": "abc",
    "QueueName": "abc"
}

输出示例

{
    "Response": {
        "InstanceId": "abc",
        "VirtualHost": "abc",
        "QueueName": "abc",
        "QueueType": "abc",
        "Consumers": 0,
        "Durable": true,
        "AutoDelete": true,
        "Remark": "abc",
        "MessageTTL": 0,
        "AutoExpire": 0,
        "MaxLength": 0,
        "MaxLengthBytes": 0,
        "DeliveryLimit": 0,
        "OverflowBehaviour": "abc",
        "DeadLetterExchange": "abc",
        "DeadLetterRoutingKey": "abc",
        "SingleActiveConsumer": true,
        "MaximumPriority": 0,
        "LazyMode": true,
        "MasterLocator": "abc",
        "MaxInMemoryLength": 0,
        "MaxInMemoryBytes": 0,
        "CreateTime": 0,
        "Node": "abc",
        "DeadLetterStrategy": "abc",
        "QueueLeaderLocator": "abc",
        "QuorumInitialGroupSize": 0,
        "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 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
中国站
http://www.vxiaotou.com