tencent cloud

APIs

文档APIsTDMQ for RabbitMQData Types

数据结构

Download
聚焦模式
字号
最后更新时间： 2026-06-25 19:58:01

ExchangeQuota

exchange使用配额信息

被如下接口引用：DescribeRabbitMQServerlessInstance。

名称 类型 描述
MaxExchange Integer 可创建最大exchange数
UsedExchange Integer 已创建exchange数

Filter

过滤参数

被如下接口引用：DescribeRabbitMQServerlessVirtualHost, ListRabbitMQServerlessInstances。

名称 类型 必选 描述
Name String 否 过滤参数的名字
Values Array of String 否 数值

QueueQuota

queue使用配额信息

被如下接口引用：DescribeRabbitMQServerlessInstance。

名称 类型 描述
MaxQueue Integer 可创建最大Queue数
UsedQueue Integer 已创建Queue数

RabbitMQBindingListInfo

Rabbitmq路由关系列表成员

被如下接口引用：DescribeRabbitMQServerlessBindings。

名称 类型 描述
BindingId Integer

路由关系id
VirtualHost String

Vhost参数
Source String

源exchange名称
DestinationType String

目标类型,queue或exchange
Destination String

目标资源名称
RoutingKey String

绑定key
SourceExchangeType String

源exchange类型
CreateTime String

创建时间
ModifyTime String

修改时间
Arguments Array of RabbitMQServerlessKeyValuePair

绑定参数，header类型的Exchange绑定时，可以传入参数。其它类型 Exchange 无需传入

RabbitMQClusterInfo

RabbiteMQ集群基本信息

被如下接口引用：DescribeRabbitMQServerlessInstance。

名称 类型 描述
ClusterId String

集群ID
ClusterName String

集群名称
Region String

地域信息
CreateTime Integer

创建时间，毫秒为单位
Remark String

集群说明信息
Vpcs Array of VpcEndpointInfo

VPC及网络信息
ZoneIds Array of Integer

可用区信息
VirtualHostNumber Integer

虚拟主机数量
QueueNumber Integer

队列数量
MessagePublishRate Float

每秒生产消息数 单位：条/秒
MessageStackNumber Integer

堆积消息数 单位：条
ExpireTime Integer

过期时间
ChannelNumber Integer

Channel数量
ConnectionNumber Integer

Connection数量
ConsumerNumber Integer

Consumer数量
ExchangeNumber Integer

Exchang数量
ExceptionInformation String

集群异常信息
ClusterStatus Integer

实例状态，0表示创建中，1表示正常，2表示隔离中，3表示已销毁，4 - 异常, 5 - 发货失败
AutoRenewFlag Integer

自动续费标记，0表示默认状态(用户未设置，即初始状态即手动续费)， 1表示自动续费，2表示明确不自动续费(用户设置)
MirrorQueuePolicyFlag Integer

是否开启镜像队列策略。1表示开启，0表示没开启。
MessageConsumeRate Float

每秒消费消息数 单位：条/秒
ClusterVersion String

集群版本信息
PayMode Integer

计费模式，0-后付费，1-预付费
InstanceType Integer

集群类型
MessageRetainTime Integer

消息保留时间，单位小时
SendReceiveRatio Float

发送消息流量比例
TraceTime Integer

消息轨迹保留时间，单位小时
Tags Array of RabbitMQServerlessTag

实例标签列表
ElasticTpsFlag Boolean

是否开启弹性tps
ElasticTpsRatio Float

弹性tps倍数，默认弹1倍
MaxRedeliverCount Integer

最大重投次数
ConsumerTimeout Integer

消费超时时间，单位min

RabbitMQClusterSpecInfo

RabbitMQ集群规格信息

被如下接口引用：DescribeRabbitMQServerlessInstance。

名称 类型 描述
SpecName String 集群规格名称
MaxTps Integer 峰值tps
MaxQueueNum Integer 最大队列数
MaxExchangeNum Integer 最大交换机数
MaxVhostNum Integer 最大vhost数
MaxConnNum Integer 最大连接数
MaxUserNum Integer 最大用户数
MaxBandWidth Integer 峰值带宽，已废弃
PublicNetworkTps Integer 公网带宽，已废弃
Features String 实例对应的功能列表，true表示支持，false 表示不支持

RabbitMQConnection

RabbitMQ连接详情

被如下接口引用：DescribeRabbitMQServerlessConnection。

名称 类型 描述
ConnectionName String 连接名称
PeerHost String 客户端ip
State String 连接状态，包括 starting、tuning、opening、running、flow、blocking、blocked、closing 和 closed
User String 连接使用用户
SSL Boolean 是否开启ssl
Protocol String 连接协议
Channels Integer 连接下的channel数
IncomingBytes Float 入流量大小，单位 bytes
OutgoingBytes Float 出流量大小，单位bytes
Heartbeat Integer 心跳间隔时间，默认60s
MaxChannel Integer 一个链接最大的channel数，默认1024
IdleSince String 空闲时间点

RabbitMQConsumersListInfo

队列消费者列表信息

被如下接口引用：DescribeRabbitMQServerlessConsumers。

名称 类型 描述
ClientIp String 客户端Ip
ConsumerTag String 消费者Tag
QueueName String 消费目标队列
AckRequired Boolean 是否需要消费者手动 ack
PrefetchCount Integer 消费者 qos 值
Active String 消费者状态
LastDeliveredTime String 最后一次投递消息时间
UnAckMsgCount Integer 消费者未确认消息数
ChannelName String consumer 所属的 channel

RabbitMQExchangeListInfo

RabbitMQ exchange列表成员信息

被如下接口引用：DescribeRabbitMQServerlessExchanges。

名称 类型 描述
ExchangeName String exchange 名
Remark String 备注说明
ExchangeType String exchange 类型, 支持 "fanout","direct","topic","headers"
VirtualHost String VHost参数
ExchangeCreator String exchange 创建者, "system":"系统创建", "user":"用户创建"
CreateTimeStamp String exchange 创建时间
ModTimeStamp String exchange 修改时间
MessageRateIn Float 输入消息速率
MessageRateOut Float 输出消息速率
Durable Boolean 是否为持久化交换机，true 为持久化，false 为非持久化
AutoDelete Boolean 是否为自动删除交换机，true 为自动删除，false 为非自动删除
Internal Boolean 是否为内部交换机，true 为内部交换机
InstanceId String 交换机所属实例 ID
Policy String 生效的策略名称
Arguments String 扩展参数 key-value 对象
MessagesDelayed Integer 未调度的延时消息数量

RabbitMQPermission

RabbitMQ权限详情

被如下接口引用：DescribeRabbitMQServerlessPermission。

名称 类型 描述
InstanceId String 集群实例Id
User String 用户名，权限关联的用户
VirtualHost String vhost名
ConfigRegexp String 权限类型，declare相关操作，该用户可操作该vhost下的资源名称正则表达式
WriteRegexp String 权限类型，消息写入相关操作，该用户可操作该vhost下的资源名称正则表达式
ReadRegexp String 权限类型，消息读取相关操作，该用户可操作该vhost下的资源名称正则表达式
CreateTime String 创建时间
ModifyTime String 修改时间

RabbitMQQueueListConsumerDetailInfo

RabbitMQ队列列表消费者信息

被如下接口引用：DescribeRabbitMQServerlessQueues。

名称 类型 描述
ConsumersNumber Integer 消费者数量

RabbitMQQueueListInfo

RabbitMQ队列列表成员信息

被如下接口引用：DescribeRabbitMQServerlessQueues。

名称 类型 描述
QueueName String 队列名
Remark String 备注说明
ConsumerDetail RabbitMQQueueListConsumerDetailInfo 消费者信息
QueueType String 队列类型，取值 "classic"，"quorum"
MessageHeapCount Integer 消息堆积数
MessageRateIn Float 消息生产速率，每秒
MessageRateOut Float 消息消费速率，每秒
CreateTime String 创建时间
ModifyTime String 修改时间
Durable Boolean 队列是否持久化，true 为持久化，false 为非持久化
AutoDelete Boolean 队列是否为自动删除队列，true 为自动删除，false 为非自动删除
InstanceId String 队列所属实例 ID
VirtualHost String 队列所属虚拟主机名称
Node String 队列所在主节点名称
Policy String 生效的策略名称
Arguments String 扩展参数 key-value 对象
Exclusive Boolean 是否独占队列

RabbitMQServerlessAccessInfo

公网访问信息

被如下接口引用：DescribeRabbitMQServerlessInstance。

名称 类型 描述
PublicAccessEndpoint String 公网域名
PublicDataStreamStatus String 公网状态
PublicClbId String 公网CLB实例ID

RabbitMQServerlessEndpoint

接入点

被如下接口引用：ListRabbitMQServerlessInstances。

名称 类型 描述
VpcId String vpc id
SubnetId String subnet id
VpcEndpoint String 接入地址
VpcDataStreamEndpointStatus String 接入地址状态
PublicNetwork Boolean 是否是公网
AccessStrategy String 访问策略
Bandwidth Integer 带宽

RabbitMQServerlessInstance

rabbitmq serverless 实例

被如下接口引用：ListRabbitMQServerlessInstances。

名称 类型 描述
InstanceId String 实例Id
InstanceName String 实例名称
InstanceVersion String 实例版本号
Status Integer 实例状态，0表示创建中，1表示正常，2表示隔离中，3表示已销毁，4 - 异常, 5 - 发货失败
MaxTps Integer TPS
MaxBandWidth Integer 带宽
ExpireTime Integer 集群过期时间
AutoRenewFlag Integer 自动续费标记，0表示默认状态(用户未设置，即初始状态即手动续费)， 1表示自动续费，2表示明确不自动续费(用户设置)
PayMode Integer 0-后付费，1-预付费
Remark String 备注
SpecName String 集群规格
ExceptionInformation String 异常信息
PublicAccessEndpoint String 公网接入点
Vpcs Array of RabbitMQServerlessEndpoint 私有网络接入点
ClusterStatus Integer 实例状态，0表示创建中，1表示正常，2表示隔离中，3表示已销毁，4 - 异常, 5 - 发货失败
InstanceType Integer 集群类型：1
CreateTime Integer 过期时间
NodeCount Integer 为了兼容托管版，固定值 0
MaxStorage Integer 为了兼容托管版，固定值 0
IsolatedTime Integer 隔离时间
ServerlessExt String Serverless 扩展字段
Tags Array of RabbitMQServerlessTag 实例标签列表

RabbitMQServerlessKeyValuePair

键值对

被如下接口引用：CreateRabbitMQServerlessBinding, DescribeRabbitMQServerlessBindings。

名称 类型 必选 描述
Key String 否 键
Value String 否 值

RabbitMQServerlessTag

标签

被如下接口引用：DescribeRabbitMQServerlessInstance, ListRabbitMQServerlessInstances, ModifyRabbitMQServerlessInstance。

名称 类型 必选 描述
TagKey String 否 标签键
TagValue String 否 标签值

RabbitMQServerlessWhiteListInfo

公网白名单信息

被如下接口引用：DescribeRabbitMQServerlessInstance。

名称 类型 描述
PublicDataStreamWhiteList String 公网数据流白名单
PublicDataStreamWhiteListStatus String 公网数据流白名单状态

RabbitMQUser

RabbitMQ用户实体详情

被如下接口引用：DescribeRabbitMQServerlessUser。

名称 类型 描述
InstanceId String 集群实例Id
User String 用户名，登录时使用
Password String 密码，登录时使用
Description String 用户描述
Tags Array of String 用户标签，用于决定改用户访问RabbitMQ Management的权限范围
CreateTime String 用户创建时间
ModifyTime String 用户最后修改时间
Type String 用户类型，System：系统创建，User：用户创建
MaxConnections Integer 该用户所能允许的最大连接数
MaxChannels Integer 该用户所能允许的最大通道数

RabbitMQVirtualHostInfo

RabbitMQ的vhost详情

被如下接口引用：DescribeRabbitMQServerlessVirtualHost。

名称 类型 描述
InstanceId String 集群实例Id
VirtualHost String vhost名
Description String vhost描述信息
Tags Array of String vhost标签
CreateTime String 创建时间
ModifyTime String 修改时间
VirtualHostStatistics RabbitMQVirtualHostStatistics vhost概览统计信息
Status String vhost状态，与原生控制台对应，有running、partial、stopped、unknown
MessageHeapCount Integer 消息堆积数
MessageRateIn Float 输入消息速率
MessageRateOut Float 输出消息速率
MirrorQueuePolicyFlag Boolean 是否存在镜像队列策略，true 为存在，false 为不存

RabbitMQVirtualHostStatistics

vhost概览统计信息

被如下接口引用：DescribeRabbitMQServerlessVirtualHost。

名称 类型 描述
CurrentQueues Integer 当前vhost的queue数量
CurrentExchanges Integer 当前vhost的exchange数量
CurrentConnections Integer 当前vhost的连接数量
CurrentChannels Integer 当前vhost的channel数量
CurrentUsers Integer 当前vhost的用户数量

UserQuota

用户数配额

被如下接口引用：DescribeRabbitMQServerlessInstance。

名称 类型 描述
MaxUser Integer 最大用户数
UsedUser Integer 已用用户数

VirtualHostQuota

虚拟主机配额

被如下接口引用：DescribeRabbitMQServerlessInstance。

名称 类型 描述
MaxVirtualHost Integer 最大虚拟主机数
UsedVirtualHost Integer 已经使用的虚拟主机数

VpcEndpointInfo

VPC接入点信息

被如下接口引用：DescribeRabbitMQServerlessInstance。

名称 类型 必选 描述
VpcId String 是 vpc的id
SubnetId String 是 子网id
VpcEndpoint String 是 vpc接入点信息
VpcDataStreamEndpointStatus String 否 vpc接入点状态
OFF/ON/CREATING/DELETING
上一篇: CreateRabbitMQServerlessBinding下一篇: Error Codes

帮助和支持

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

填写满意度调查问卷，共创更好文档体验。

文档反馈