tencent cloud

APIs

文档APIsCloud Message QueueData Types

数据结构

Download
聚焦模式
字号
最后更新时间： 2026-05-07 10:59:57

DeadLetterPolicy

死信队列策略

被如下接口引用：DescribeQueueDetail。

名称 类型 描述
DeadLetterQueue String 死信队列。
DeadLetterQueueName String 死信队列名字。
MaxTimeToLive Integer 最大未消费过期时间。Policy为1时必选。范围300-43200，单位秒，需要小于消息最大保留时间MsgRetentionSeconds。
Policy Integer 死信队列策略。
MaxReceiveCount Integer 最大接收次数。

DeadLetterSource

死信源队列信息

被如下接口引用：DescribeQueueDetail。

名称 类型 描述
QueueId String 消息队列ID。
QueueName String 消息队列名字。

Filter

过滤参数

被如下接口引用：DescribeQueueDetail, DescribeTopicDetail。

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

QueueSet

批量queue属性信息

被如下接口引用：DescribeQueueDetail。

名称 类型 描述
QueueId String 消息队列ID。
RewindSeconds Integer 回溯队列的消息回溯时间最大值，取值范围0 - 43200秒，0表示不开启消息回溯。
CreateUin Integer 创建者Uin。
LastModifyTime Integer 最后一次修改队列属性的时间。返回 Unix 时间戳，精确到秒。
VisibilityTimeout Integer 消息可见性超时。取值范围1 - 43200秒（即12小时内），默认值30。
QueueName String 消息队列名字。
Trace Boolean 消息轨迹。true表示开启，false表示不开启。
Tags Array of Tag 关联的标签。
RewindMsgNum Integer 已调用 DelMsg 接口删除，但还在回溯保留时间内的消息数量。
MaxDelaySeconds Integer 飞行消息最大保留时间。
TransactionPolicy TransactionPolicy 事务消息策略。
注意：此字段可能返回 null，表示取不到有效值。
MsgRetentionSeconds Integer 消息保留周期。取值范围60-1296000秒（1min-15天），默认值345600秒（4 天）。
DelayMsgNum Integer 延迟消息数。
MaxMsgHeapNum Integer 最大堆积消息数。取值范围在公测期间为 1,000,000 - 10,000,000，正式上线后范围可达到 1000,000-1000,000,000。默认取值在公测期间为 10,000,000，正式上线后为 100,000,000。
PollingWaitSeconds Integer 消息接收长轮询等待时间。取值范围0 - 30秒，默认值0。
Bps Integer 带宽限制。
InactiveMsgNum Integer 在队列中处于 Inactive 状态（正处于被消费状态）的消息总数，为近似值。
DeadLetterPolicy DeadLetterPolicy 死信队列策略。
注意：此字段可能返回 null，表示取不到有效值。
ActiveMsgNum Integer 在队列中处于 Active 状态（不处于被消费状态）的消息总数，为近似值。
MaxMsgSize Integer 消息最大长度。取值范围1024 - 1048576 Byte（即1K - 1024K），默认值65536。
MinMsgTime Integer 消息最小未消费时间，单位为秒。
DeadLetterSource Array of DeadLetterSource 死信队列。
Transaction Boolean 事务消息队列。true表示是事务消息，false表示不是事务消息。
注意：此字段可能返回 null，表示取不到有效值。
Qps Integer 每秒钟生产消息条数的限制，消费消息的大小是该值的1.1倍。
CreateTime Integer 队列的创建时间。返回 Unix 时间戳，精确到秒。
Migrate Integer 是否迁移到新版本。0 表示仅同步元数据，1 表示迁移中，2 表示已经迁移完毕，3 表示回切状态，曾经迁移过，4 未迁移。

Tag

标签

被如下接口引用：DescribeQueueDetail, DescribeTopicDetail。

名称 类型 描述
TagKey String 标签Key
TagValue String 标签值

TopicSet

topic返回信息展示字段

被如下接口引用：DescribeTopicDetail。

名称 类型 描述
MsgCount Integer 当前该主题中消息数目（消息堆积数）。
TopicId String 主题的 ID。
MaxMsgSize Integer 消息最大长度。取值范围1024 - 1048576Byte（即1 - 1024K），默认值为65536。
Trace Boolean 消息轨迹。true表示开启，false表示不开启。
Tags Array of Tag 关联的标签。
CreateUin Integer 创建者 Uin，CAM 鉴权 resource 由该字段组合而成。
FilterType Integer 描述用户创建订阅时选择的过滤策略：
FilterType = 1表示用户使用 FilterTag 标签过滤;
FilterType = 2表示用户使用 BindingKey 过滤。
TopicName String 主题名称。
LastModifyTime Integer 最后一次修改主题属性的时间。返回 Unix 时间戳，精确到秒。
MsgRetentionSeconds Integer 消息在主题中最长存活时间，从发送到该主题开始经过此参数指定的时间后，不论消息是否被成功推送给用户都将被删除，单位为秒。固定为一天（86400秒），该属性不能修改。
Qps Integer 每秒钟发布消息的条数。
CreateTime Integer 主题的创建时间。返回 Unix 时间戳，精确到秒。
Migrate Integer 是否迁移到新版本。0 表示未迁移，1 表示迁移中，2 表示已经迁移完毕，3 表示回切状态，曾经迁移过，4 未知状态。

TransactionPolicy

事务消息策略

被如下接口引用：DescribeQueueDetail。

名称 类型 描述
MaxQueryCount Integer 最大查询次数。
FirstQueryInterval Integer 第一次回查时间。
上一篇: Introduction下一篇: Error Codes

帮助和支持

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

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

文档反馈