数据结构
最近更新时间: 2026-09-17 00:00:44
BusinessSystem
单元化客户映射服务地址
被如下接口引用：NotifyDeploymentUnitArchChanged
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| BusinessSystemName | 否 | 否 | String | 业务系统名称 示例值： 无 |
| BusinessSystemType | 否 | 否 | String | 业务系统类型 示例值： 无 |
| BusinessSystemId | 否 | 否 | String | 业务系统 ID 示例值： 无 |
ClientSubscriptionInfo
客户端订阅详情，可用于辅助判断哪些客户端订阅关系不一致
被如下接口引用：DescribeRocketMQSubscriptions、DescribeRocketMQTopic、DescribeRocketMQTopics
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SubString | 是 | 是 | String | 订阅表达式 示例值： test_tag |
| ExpressionType | 是 | 是 | String | 订阅方式 示例值： TAG |
| ClientId | 是 | 否 | String | 客户端ID 示例值： rocketmq-2p9vx3ax9jxg |
| ClientAddr | 是 | 是 | String | 客户端IP 示例值： 1.1.1.12 |
| Topic | 是 | 是 | String | 订阅主题 示例值： test_topic |
EnvironmentRole
环境角色集合
被如下接口引用：DescribeEnvironmentRoles、DescribeRocketMQEnvironmentRoles
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| CreateTime | 是 | 否 | Datetime | 创建时间。 示例值： 2023-07-18 17:06:57 |
| UpdateTime | 是 | 否 | Datetime | 更新时间。 示例值： 2023-07-18 17:06:57 |
| EnvironmentId | 是 | 否 | String | 环境（命名空间）。 示例值： test_namespace |
| RoleName | 是 | 否 | String | 角色名称。 示例值： test_role_name |
| Permissions | 是 | 否 | Array of String | 授权项，最多只能包含produce、consume两项的非空字符串数组。 示例值： ["produce"] |
| RoleDescribe | 是 | 否 | String | 角色描述。 示例值： 测试角色 |
RocketMQTopicRouteAccessInfo
访问主题路由的信息
被如下接口引用：DescribeRocketMQMigrateTopicAccessInfo
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| LastAccessTimestamp | 否 | 是 | Uint64 | 最近访问的时间戳，毫秒为单位 示例值： 无 |
| ClientIP | 否 | 是 | String | 客户端地址 示例值： 无 |
Consumer
消费者
被如下接口引用：DescribeSubscriptions
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ConnectedSince | 是 | 是 | String | 消费者开始连接的时间。 示例值： 2024-04-11T23:03:47.328+08:00 |
| ConsumerAddr | 是 | 是 | String | 消费者地址。 示例值： 30.11.19.46:40940 |
| ConsumerName | 是 | 是 | String | 消费者名称。 示例值： devName1 |
| ClientVersion | 是 | 是 | String | 消费者版本。 示例值： 2.7.1 |
| Partition | 否 | 是 | Int64 | Partition数量 示例值： 0 |
RocketMQRouterRuleInfoItem
RocketMQ Router输出的规则信息
被如下接口引用：DeleteRocketMQRouterRule、DescribeRocketMQRouterRuleDetail、DescribeRocketMQRouterRules、UpdateRocketMQRouterRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TenMQTTTarget | 否 | 是 | RouterTencentMQTTTarget | 腾讯云MQTT目标集群信息 示例值：查看 |
| RemarkName | 否 | 是 | String | 规则备注 示例值： - |
| SourceType | 否 | 是 | String | 源类型。 OPEN_SOURCE_ROCKETMQ：开源rocketmq ALI_ROCKETMQ：阿里云rocketmq TENCENT_ROCKETMQ：腾讯云rocketmq ALI_MNS：阿里云mns 示例值： TENCENT_ROCKETMQ |
| TenRocketMQSource | 否 | 是 | RouterTencentRocketMQSource | 腾讯云rocketmq源信息 示例值：查看 |
| Status | 否 | 是 | String | 规则状态。 UNKNOWN：未知 START_FAIL：启动/重启失败 JUST_BE_CREATED：已创建 JUST_BE_RE_CREATING：正在重建 PAUSED：已暂停 RUNNING：运行中 SHUTDOWN：已关闭 示例值： RUNNING |
| CreateTime | 否 | 是 | Int64 | 创建时间, 毫秒级时间戳 示例值： 1694056404492 |
| AliRocketMQTarget | 否 | 是 | RouterRocketMQTarget | 阿里云rocketmq目标信息 示例值：查看 |
| AliMessageServiceSource | 否 | 是 | RouterMessageServiceSource | 阿里云mns源信息 示例值：查看 |
| TenRocketMQTarget | 否 | 是 | RouterTencentRocketMQTarget | 腾讯云rocketmq目标信息 示例值：查看 |
| AliasName | 否 | 是 | String | 别名 示例值： - |
| RuleId | 否 | 是 | String | 规则id 示例值： router-xxxx |
| AliMessageServiceTarget | 否 | 是 | RouterMessageServiceTarget | 阿里云mns目标信息 示例值：查看 |
| ApacheRocketMQTarget | 否 | 是 | RouterRocketMQTarget | 开源rocketmq目标信息 示例值：查看 |
| TaskStatusReason | 否 | 是 | String | 任务状态产生原因. UNKNOWN: 未知 CleanTaskBySystem: 自动被系统清理 CleanTaskByRouterOffline: 自动被系统清理 CreateTask: 创建任务失败 RestartTask : 重启任务失败 CheckBeforeStartTask: 启动任务前参数检查失败 DeleteByUser: 用户删除了任务 PausedByUser：用户暂停了任务 ParamCheckFail：启动/重启时参数检查失败 ProducerFail: 生产失败 ProducerError: 生产异常 示例值： PausedByUser |
| UpdateTime | 否 | 是 | Int64 | 更新时间，毫秒级时间戳 示例值： 1694056404492 |
| TenMQTTSource | 否 | 是 | RouterTencentMQTTSource | 腾讯云MQTT源集群信息 示例值：查看 |
| TargetType | 否 | 是 | String | 目标类型，和 SourceType 字段一样 示例值： TENCENT_ROCKETMQ |
| AliRocketMQSource | 否 | 是 | RouterRocketMQSource | 阿里云rocketmq源信息 示例值：查看 |
| ApacheRocketMQSource | 否 | 是 | RouterRocketMQSource | 开源rocketmq源信息 示例值：查看 |
| SyncType | 否 | 是 | String | 数据同步类型。 Topic: 按topic同步 示例值： Topic |
VpcBindRecord
vcp绑定记录
被如下接口引用：DescribeBindVpcs
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| UniqueVpcId | 是 | 否 | String | 租户Vpc Id 示例值： vpc-8jjiuayds |
| UniqueSubnetId | 是 | 否 | String | 租户Vpc子网Id 示例值： subnet-1i12ofyz |
| RouterId | 是 | 否 | String | 路由Id 示例值： 124323 |
| Ip | 是 | 否 | String | Vpc的Id 示例值： 10.0.0.120 |
| Port | 是 | 否 | Uint64 | Vpc的Port 示例值： 8080 |
| Remark | 是 | 是 | String | 说明，128个字符以内 示例值： devRemark |
RouterRocketMQTarget
rocketmq router任务的目标信息
被如下接口引用：CreateRocketMQRouterRule、DeleteRocketMQRouterRule、DescribeRocketMQRouterRuleDetail、DescribeRocketMQRouterRules、UpdateRocketMQRouterRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TargetProduceConcurrentThreadCount | 否 | 是 | Int64 | 生产者并发数，可以不用填，可以在规则创建后修改 示例值： 1 |
| AccessKey | 是 | 是 | String | access key 示例值： - |
| NameServerAddressList | 是 | 是 | String | namesrv地址列表，也可以是云厂商提供的接入点信息 示例值： 127.0.0.1:9876 |
| Namespace | 否 | 是 | String | 4.X的命名空间，没有使用则留空，5.X也留空。 naemspace 需要包含MQ_INST那部分. 比如：MQ_INST_rocketmqka57d53rnn5_tiger_namespace 示例值： - |
| SecretKey | 是 | 是 | String | secret key 示例值： - |
| Topic | 是 | 是 | String | topic名字 示例值： - |
RocketMQConsumerClient
消费者客户端信息
被如下接口引用：DescribeRocketMQConsumerClients
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ClientId | 是 | 是 | String | 客户端ID 示例值： 127.0.0.1@25760#13749780392400 |
| ClientAddr | 是 | 是 | String | 客户端地址 示例值： 127.0.0.1:6133 |
SubscriptionTopic
订阅关系
被如下接口引用：DeleteSubscriptions
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| EnvironmentId | 是 | 否 | String | 环境（命名空间）名称。 示例值： devNs |
| TopicName | 是 | 否 | String | 主题名称。 示例值： devTopic |
| SubscriptionName | 是 | 否 | String | 订阅名称。 示例值： devSub |
RouterMessageServiceSource
rocketmq router mns 源信息
被如下接口引用：CreateRocketMQRouterRule、DeleteRocketMQRouterRule、DescribeRocketMQRouterRuleDetail、DescribeRocketMQRouterRules、UpdateRocketMQRouterRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SourceConsumeConcurrentThreadCount | 否 | 是 | Int64 | mns消费并发数 示例值： 1 |
| FilterFromTimestampMs | 否 | 否 | Int64 | 过滤时间戳，毫秒级时间戳 示例值： 1694055357311 |
| AccessKey | 是 | 是 | String | access key 示例值： - |
| EnableDecodeBody | 否 | 是 | String | 是否自动解码mns body。 ON：自动解码，复制后的消息内容为解码后的明文。 OFF：不用解码，保持Mns消息体原始状态 示例值： OFF |
| Endpoint | 是 | 是 | String | mns接入点。 需要和router内网联通，一般是公网接入点 示例值： http://1111111.mns.cn-shenzhen.aliyuncs.com |
| Queue | 是 | 是 | String | mns queue名字。 可以在https://mns.console.aliyun.com/region/cn-shenzhen/queues 看到 示例值： - |
| SecretKey | 是 | 是 | String | secret key 示例值： - |
RocketMQConsumerConnection
在线消费者情况
被如下接口引用：DescribeRocketMQConsumerConnections
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Language | 是 | 否 | String | 消费者应用的语言版本 示例值： JAVA |
| Accumulative | 是 | 否 | Int64 | 消息堆积量 示例值： 100 |
| Version | 是 | 否 | String | 消费端版本 示例值： V4.9.7 |
| ClientId | 是 | 否 | String | 消费者实例ID 示例值： rocketmq-2p9vx3ax9jxg |
| ClientAddr | 是 | 否 | String | 消费者实例的地址和端口 示例值： 192.168.0.1:5555 |
RocketMQVipInstance
RocketMQ专享实例信息
被如下接口引用：DescribeRocketMQVipInstances
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Retention | 是 | 否 | Int64 | 实例消息保留时间，小时为单位 示例值： 72 |
| InstanceId | 是 | 否 | String | 实例id 示例值： rmq-4k4orqgq1 |
| ConfigDisplay | 是 | 否 | String | 实例配置规格名称 示例值： 基础型 |
| MaxStorage | 是 | 否 | Uint64 | 存储容量，GB为单位 示例值： 100 |
| Remark | 是 | 否 | String | 备注信息 示例值： remark-info |
| SpecName | 是 | 否 | String | 实例配置ID 示例值： vip-basic-1 |
| CanVerticalChange | 是 | 否 | Bool | 是否可以垂直变配 示例值： false |
| InstanceName | 是 | 否 | String | 实例名称 示例值： order-instance |
| MaxBandWidth | 是 | 否 | Uint64 | 峰值带宽，Mbps为单位 示例值： 1200 |
| AclEnabled | 是 | 否 | Bool | 是否开启ACL鉴权 示例值： true |
| Status | 是 | 否 | Uint64 | 实例状态，0表示创建中，1表示正常，2表示隔离中，3表示已销毁，4 - 异常, 5 - 发货失败，6 - 变配中，7 - 变配失败 示例值： 0 |
| ExpireTime | 是 | 否 | Uint64 | 实例到期时间，毫秒为单位 示例值： 100000 |
| AutoRenewFlag | 是 | 否 | Uint64 | 自动续费标记，0表示默认状态(用户未设置，即初始状态即手动续费)， 1表示自动续费，2表示明确不自动续费(用户设置) 示例值： 0 |
| PayMode | 是 | 否 | Uint64 | 0-后付费，1-预付费 示例值： 0 |
| DestroyTime | 否 | 否 | Uint64 | 销毁时间 示例值： 369182637452345 |
| InstanceVersion | 是 | 否 | String | 实例版本 示例值： 4.9.3 |
| NodeCount | 是 | 否 | Uint64 | 节点数量 示例值： 5 |
| MaxTps | 是 | 否 | Uint64 | 峰值TPS 示例值： 10000 |
| MaxRetention | 是 | 否 | Int64 | 最大可设置消息保留时间，小时为单位 示例值： 168 |
| MinRetention | 是 | 否 | Int64 | 最小可设置消息保留时间，小时为单位 示例值： 24 |
Subscription
订阅者
被如下接口引用：DescribeSubscriptions
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TopicName | 是 | 否 | String | 主题名称。 示例值： devTopic |
| EnvironmentId | 是 | 否 | String | 环境（命名空间）名称。 示例值： devNs |
| ConnectedSince | 是 | 是 | String | 消费者开始连接的时间。 示例值： 2024-09-12T16:01:59.677+08:00 |
| ConsumerAddr | 是 | 是 | String | 消费者地址。 示例值： 127.0.0.1 |
| ConsumerCount | 是 | 是 | String | 消费者数量。 示例值： 11 |
| ConsumerName | 是 | 是 | String | 消费者名称。 示例值： devConsumerName |
| MsgBacklog | 是 | 是 | String | 堆积的消息数量。 示例值： 1 |
| MsgRateExpired | 是 | 是 | String | 于TTL，此订阅下没有被发送而是被丢弃的比例。 示例值： 1 |
| MsgRateOut | 是 | 是 | String | 消费者每秒分发消息的数量之和。 示例值： 1 |
| MsgThroughputOut | 是 | 是 | String | 消费者每秒消息的byte。 示例值： 1 |
| SubscriptionName | 是 | 是 | String | 订阅名称。 示例值： devSubscriptionName |
| ConsumerSets | 是 | 是 | Array of Consumer | 消费者集合。 示例值：查看 |
| IsOnline | 是 | 是 | Bool | 是否在线。 示例值： true |
| ConsumersScheduleSets | 是 | 是 | Array of ConsumersSchedule | 消费进度集合。 示例值：查看 |
| Remark | 是 | 是 | String | 备注。 示例值： devRemark |
| CreateTime | 是 | 是 | Datetime | 创建时间。 示例值： 2023-10-05 14:30:00 |
| UpdateTime | 是 | 是 | Datetime | 最近修改时间。 示例值： 2023-12-05 14:30:00 |
| BlockedSubscriptionOnUnackedMsgs | 否 | 是 | Bool | 是否由于未 ack 数到达上限而被 block 注意：此字段可能返回 null，表示取不到有效值。 示例值： true |
| SubType | 否 | 是 | String | 订阅类型，Exclusive，Shared，Failover， Key_Shared，空或NULL表示未知， 注意：此字段可能返回 null，表示取不到有效值。 示例值： Shared |
| MaxUnackedMsgNum | 否 | 是 | Int64 | 未 ack 消息数上限 注意：此字段可能返回 null，表示取不到有效值。 示例值： 5000 |
VpcConfig
VPC配置信息
被如下接口引用：DescribeRocketMQCluster、DescribeRocketMQClusters
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcId | 是 | 否 | String | vpc的id 示例值： vpc-9dlrd5h1 |
| SubnetId | 是 | 否 | String | 子网id 示例值： subnet-jadmas |
RocketMQRoleConfig
RocketMQ角色配置信息
被如下接口引用：CreateRocketMQMigrationTask
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Remark | 否 | 否 | String | 备注 示例值： remark info |
| PermType | 否 | 否 | String | 权限类型，默认按集群授权（Cluster：集群级别；TopicAndGroup：主题&消费组级别） 示例值： Cluster |
| DetailedRolePerms | 否 | 否 | Array of DetailedRolePerm | Topic和Group维度权限配置 示例值：查看 |
| RoleName | 否 | 否 | String | 角色名，对应SecretKey 示例值： test_role |
| RoleToken | 否 | 否 | String | accessKey 示例值： akTd0eozCSH78BYp1E |
| EnvironmentId | 否 | 否 | String | 命名空间 示例值： test_ns |
| Permissions | 否 | 否 | Array of String | 角色权限 示例值： [ "produce", "consume" ] |
RocketMQGroupConfig
RocketMQ消费组配置信息
被如下接口引用：CreateRocketMQMigrationTask、ImportRocketMQConsumerGroups
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ConsumeBroadcastEnable | 是 | 否 | Bool | 是否开启广播消费 示例值： false |
| ConsumeEnable | 是 | 否 | Bool | 是否开启消费 示例值： false |
| Remark | 否 | 否 | String | 备注信息 示例值： remark info |
| ConsumerGroupType | 否 | 否 | String | 协议类型，支持以下枚举值 TCP; HTTP; 示例值： TCP |
| Namespace | 是 | 否 | String | 命名空间 示例值： test_ns |
| GroupName | 是 | 否 | String | 消费组名称 示例值： test_group |
Tag
标签的key/value的类型
被如下接口引用：CreateCluster、CreateRocketMQCluster、CreateRocketMQGroupV2、DescribeClusterDetail、DescribeClusters、DescribeRocketMQClusters、DescribeRocketMQConsumerConnections、DescribeRocketMQGroups、DescribeRocketMQTopic、DescribeRocketMQTopics
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TagKey | 是 | 是 | String | 标签的key的值 示例值： test_tag_key |
| TagValue | 是 | 是 | String | 标签的Value的值 示例值： test_tag_value1 |
ConfigTypeInfoOpt
集群模块配置类型描述
被如下接口引用：DescribeClusterConfigTypeOpt
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ComponentName | 是 | 否 | String | 模块组件名称 示例值： BROKER |
| ConfigName | 是 | 否 | String | 模块配置文件名称 示例值： broker.conf |
| ModuleName | 是 | 否 | String | 配置模块名 示例值： BROKER |
AMQPVHostConnection
Vhost客户端连接情况
被如下接口引用：DescribeAMQPVHostConnections
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ClientAddr | 是 | 否 | String | 客户端实例的地址和端口 示例值： 192.168.0.1:5555 |
| Protocol | 是 | 否 | String | 客户端协议 示例值： AMQP 0.9.1 |
| Security | 是 | 否 | Bool | 是否支持SSL/TLS 示例值： true |
| ChannelNum | 是 | 否 | Uint64 | 信道数 示例值： 2 |
| ReceiveRate | 是 | 否 | Uint64 | 接受速率 示例值： 102 |
| SendRate | 是 | 否 | Uint64 | 发送速率 示例值： 97 |
RocketMQClusterDetail
租户RocketMQ集群详细信息
被如下接口引用：DescribeRocketMQClusters
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Status | 是 | 是 | Int64 | 集群状态，0:创建中，1:正常，2:销毁中，3:已删除，4: 隔离中，5:创建失败，6: 删除失败 示例值： 0 |
| Info | 是 | 否 | RocketMQClusterInfo | 集群基本信息 示例值：查看 |
| Config | 是 | 否 | RocketMQClusterConfig | 集群配置信息 示例值：查看 |
| Tags | 是 | 是 | Array of Tag | 标签 示例值：查看 |
AgentNodeOpt
代理节点
被如下接口引用：DescribeAgentNodesOpt
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ClusterName | 是 | 否 | String | 集群名称 示例值： tdmq_txy_gz_01 |
| ModuleName | 是 | 否 | String | 模块名称 示例值： ZOOKEEPER_BOOKIE |
| AgentId | 是 | 否 | String | 代理ID 示例值： 10.73.13.46-fqLzhQ6B |
| AgentIp | 是 | 否 | String | 代理IP 示例值： 10.73.13.46 |
| ProcId | 是 | 否 | Int64 | 协议ID 示例值： 8451 |
| AgentVersion | 是 | 否 | String | 代理版本 示例值： 0.0.1-SNAPSHOT |
| JavaVersion | 是 | 否 | String | JDK版本 示例值： 1.8.0_275 |
AMQPClusterDetail
租户AMQP集群详细信息
被如下接口引用：DescribeAMQPClusters
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Info | 是 | 否 | AMQPClusterInfo | 集群基本信息 示例值：查看 |
| Config | 是 | 否 | AMQPClusterConfig | 集群配置信息 示例值：查看 |
RouterMessageServiceTarget
rocketmq router mns 目标信息
被如下接口引用：CreateRocketMQRouterRule、DeleteRocketMQRouterRule、DescribeRocketMQRouterRuleDetail、DescribeRocketMQRouterRules、UpdateRocketMQRouterRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SecretKey | 是 | 是 | String | secret key 示例值： - |
| TargetProduceConcurrentThreadCount | 否 | 是 | Int64 | 发送mns的并发数 示例值： 1 |
| Topic | 否 | 是 | String | topic名字。可以在https://mns.console.aliyun.com/region/cn-shenzhen/topics 看到 示例值： - |
| AccessKey | 是 | 是 | String | access key 示例值： - |
| Endpoint | 是 | 是 | String | mns接入点，需要和router内网联通，一般是公网接入点 示例值： http://1111111.mns.cn-shenzhen.aliyuncs.com |
| Queue | 否 | 是 | String | mns queue名字。可以在https://mns.console.aliyun.com/region/cn-shenzhen/queues 看到 示例值： - |
| SendWithBase64 | 否 | 是 | String | 是否用base64编码发送mns消息。 ON：发送base64编码的消息体到mns OFF：将原始消息体发送到mns 示例值： OFF |
TraceResult
消息轨迹结果
被如下接口引用：DescribeRocketMQMsgTrace
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Stage | 是 | 否 | String | 阶段 示例值： produce |
| Data | 是 | 否 | String | 内容详情 示例值： {"", ""} |
RocketMQMessageTrack
Rocketmq消息消费track信息
被如下接口引用：DescribeRocketMQMsg
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ConsumeStatus | 是 | 否 | String | 消费状态, CONSUMED: 已消费 CONSUMED_BUT_FILTERED: 已过滤 NOT_CONSUME: 未消费 ENTER_RETRY: 进入重试队列 ENTER_DLQ: 进入死信队列 UNKNOWN: 查询不到消费状态 示例值： CONSUMED |
| TrackType | 是 | 否 | String | 消息track类型 示例值： CONSUMED_BUT_FILTERED |
| ExceptionDesc | 是 | 是 | String | 异常信息 示例值： NO Exception |
| TraceConsumeSource | 否 | 否 | String | 消费状态来源，枚举值如下： - DIFF_OFFSET：通过服务端offset计算 - TRACE_REPORT：通过上报的轨迹判断 示例值： TRACE_REPORT |
| Group | 是 | 否 | String | 消费者组 示例值： test_group |
RocketMQMigrationSubTask
RocketMQ数据迁移子任务信息
被如下接口引用：DescribeRocketMQMigrationTaskDetail
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Name | 是 | 否 | String | 主题或消费组名称 示例值： xxxx |
| Code | 是 | 否 | Int64 | 执行结果码： 0，成功 1，已存在，跳过 2，额度已满 3，名称不符合规范 4，系统错误 5，不合法的分区数 示例值： 0 |
| Type | 是 | 否 | Int64 | 元数据类型： 0，主题 1，消费组 示例值： 0 |
| Namespace | 是 | 否 | String | 命名空间 示例值： xxxx |
PartitionsTopic
分区topic
被如下接口引用：DescribeTopics
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AverageMsgSize | 是 | 是 | String | 最后一次间隔内发布消息的平均byte大小。 示例值： 10 |
| ConsumerCount | 是 | 是 | String | 消费者数量。 示例值： 10 |
| LastConfirmedEntry | 是 | 是 | String | 被记录下来的消息总数。 示例值： 10 |
| LastLedgerCreatedTimestamp | 是 | 是 | String | 最后一个ledger创建的时间。 示例值： 2024-10-08 08:04:13,809 |
| MsgRateIn | 是 | 是 | String | 本地和复制的发布者每秒发布消息的速率。 示例值： 10 |
| MsgRateOut | 是 | 是 | String | 本地和复制的消费者每秒分发消息的数量之和。 示例值： 10 |
| MsgThroughputIn | 是 | 是 | String | 本地和复制的发布者每秒发布消息的byte。 示例值： 10 |
| MsgThroughputOut | 是 | 是 | String | 本地和复制的消费者每秒分发消息的byte。 示例值： 10 |
| NumberOfEntries | 是 | 是 | String | 被记录下来的消息总数。 示例值： 10 |
| Partitions | 是 | 是 | Int64 | 子分区id。 示例值： 2 |
| ProducerCount | 是 | 是 | String | 生产者数量。 示例值： 2 |
| TotalSize | 是 | 是 | String | 以byte计算的所有消息存储总量。 示例值： 2 |
| TopicType | 是 | 是 | Uint64 | topic类型描述。 示例值： 0 |
RocketMQNamespace
RocketMQ命名空间信息
被如下接口引用：DescribeInternalRocketMQNamespaces、DescribeRocketMQNamespaces
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Ttl | 是 | 否 | Uint64 | 已废弃，未消费消息的保留时间，以毫秒单位，范围60秒到15天 示例值： 100000 |
| RetentionTime | 是 | 否 | Uint64 | 消息持久化后保留的时间，以毫秒单位 示例值： 10000 |
| Remark | 是 | 是 | String | 说明 示例值： 备注 |
| PublicEndpoint | 是 | 是 | String | 公网接入点地址 示例值： http://ip:port |
| VpcEndpoint | 是 | 是 | String | VPC接入点地址 示例值： http://ip:port |
| InternalEndpoint | 是 | 是 | String | 内部接入点地址 示例值： http://ip:port |
| UnitType | 否 | 否 | String | 单元类型 示例值： SDU |
| UnitStatus | 否 | 否 | String | 容灾状态 示例值： NOMORL |
| UnitEnv | 否 | 否 | String | 环境类型 示例值： prod |
| NamespaceId | 是 | 否 | String | 命名空间名称，3-64个字符，只能包含字母、数字、“-”及“_” 示例值： prod |
DetailedRolePerm
Topic&Group维度的权限配置
被如下接口引用：CreateRocketMQEnvironmentRole、CreateRocketMQGeneralRole、CreateRocketMQMigrationTask、ModifyRocketMQEnvironmentRole
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Remark | 否 | 否 | String | 资源备注 示例值： test remark info. |
| Resource | 是 | 否 | String | 权限对应的资源 示例值： test_topic |
| PermWrite | 是 | 否 | Bool | 是否开启生产权限 示例值： true |
| PermRead | 是 | 否 | Bool | 是否开启消费权限 示例值： false |
| ResourceType | 是 | 否 | String | 授权资源类型，枚举值如下： - Topic：主题维度 - Group：消费组维度 - Cluster：集群维度（默认值） 示例值： Topic |
Topic
主题实例
被如下接口引用：DescribeTopics
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AverageMsgSize | 是 | 是 | String | 最后一次间隔内发布消息的平均byte大小。 示例值： 10 |
| ConsumerCount | 是 | 是 | String | 消费者数量。 示例值： 120 |
| LastConfirmedEntry | 是 | 是 | String | 被记录下来的消息总数。 示例值： 100 |
| LastLedgerCreatedTimestamp | 是 | 是 | String | 最后一个ledger创建的时间。 示例值： 2024-06-19 14:15:54 |
| MsgRateIn | 是 | 是 | String | 本地和复制的发布者每秒发布消息的速率。 示例值： 130 |
| MsgRateOut | 是 | 是 | String | 本地和复制的消费者每秒分发消息的数量之和。 示例值： 140 |
| MsgThroughputIn | 是 | 是 | String | 本地和复制的发布者每秒发布消息的byte。 示例值： 160 |
| MsgThroughputOut | 是 | 是 | String | 本地和复制的消费者每秒分发消息的byte。 示例值： 120 |
| NumberOfEntries | 是 | 是 | String | 被记录下来的消息总数。 示例值： 100 |
| Partitions | 是 | 是 | Int64 | 分区数<=0：topic下无子分区。 示例值： 2 |
| ProducerCount | 是 | 是 | String | 生产者数量。 示例值： 2 |
| TotalSize | 是 | 是 | String | 以byte计算的所有消息存储总量。 示例值： 2 |
| SubTopicSets | 是 | 是 | Array of PartitionsTopic | 分区topic里面的子分区。 示例值：查看 |
| TopicType | 是 | 是 | Uint64 | topic类型描述： 0：普通消息； 1：全局顺序消息； 2：局部顺序消息； 3：重试队列； 4：死信队列； 5：事务消息。 示例值： 0 |
| EnvironmentId | 是 | 是 | String | 环境（命名空间）名称。 示例值： devNs |
| TopicName | 是 | 是 | String | 主题名称。 示例值： devTopic |
| Remark | 是 | 是 | String | 说明，128个字符以内。 示例值： devRemark |
| CreateTime | 是 | 是 | Datetime | 创建时间。 示例值： 2024-06-19 14:15:54 |
| UpdateTime | 是 | 是 | Datetime | 最近修改时间。 示例值： 2024-06-19 14:15:54 |
| ProducerLimit | 是 | 是 | String | 生产者上限。 示例值： 5000 |
| ConsumerLimit | 是 | 是 | String | 消费者上限。 示例值： 5000 |
| PulsarTopicType | 否 | 是 | Int64 | 0: 非持久非分区 1: 非持久分区 2: 持久非分区 3: 持久分区 示例值： 1 |
| ReplicationStatus | 否 | 是 | String | topic所在集群的消息同步状态 OriginReplicationOpen 源集群开启消息同步 OriginReplicationClose 源集群关闭消息同步 TargetReplicationOpen 目标集群开启消息同步 TargetReplicationClose 目标集群关闭消息同步 示例值： success |
| MsgTTL | 否 | 是 | Uint64 | 未消费消息过期时间，单位：秒 示例值： 60 |
EditableSource
RocketMQ Router可编辑的规则源属性
被如下接口引用：UpdateRocketMQRouterRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AccessKey | 否 | 否 | String | 新的access key 示例值： - |
| SecretKey | 否 | 否 | String | 新的secret key 示例值： - |
| NewFilterExpression | 否 | 否 | String | 新的RocketMQ过滤规则表达式 示例值： - |
| NewFilterFromTimestampMs | 否 | 否 | String | 新的过滤时间，毫秒级时间戳 示例值： - |
InternalRocketMQInstance
RocketMQ实例信息内部展示
被如下接口引用：DescribeInternalRocketMQInstances
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AdminFeatureEnabled | 否 | 否 | Bool | 是否开启Admin功能 示例值： true |
| AppId | 是 | 否 | Uint64 | 实例所属用户APPID 示例值： 100000 |
| Uin | 是 | 否 | String | 实例所属用户UIN 示例值： 12343444 |
| RateLimit | 是 | 否 | Uint64 | 限流值 示例值： 4000 |
| MaxRetention | 是 | 否 | Int64 | 最大可调整消息保留时间，小时为单位 示例值： 168 |
| ClusterId | 是 | 否 | String | 实例所属物理集群 示例值： rocketmq-n5degomgrwja |
| MaxQueuesPerTopic | 是 | 否 | Uint64 | 单节点主题最大可调整队列数 示例值： 16 |
| IsVIP | 是 | 否 | Bool | 是否专享实例 示例值： true |
| MinRetention | 是 | 否 | Int64 | 最小可调整消息保留时间，小时为单位 示例值： 24 |
| AclEnabled | 是 | 否 | Bool | 是否开启ACL鉴权 示例值： true |
| InstanceId | 是 | 否 | String | 实例ID 示例值： rocketmq-n5degomgrwja |
| PayStatus | 是 | 否 | String | 实例付费状态，OK正常，ISOLATED隔离中，DESTROYED已销毁 示例值： OK |
| MaxNamespaces | 是 | 否 | Uint64 | 最大可创建命名空间数量 示例值： 1 |
| MaxGroups | 是 | 否 | Uint64 | 最大可创建消费组数量 示例值： 100 |
| Retention | 是 | 否 | Int64 | 消息保留时间，小时为单位 示例值： 72 |
| AutoCreateTopicEnabled | 否 | 否 | Bool | 是否开启自动创建Topic 示例值： true |
| Name | 是 | 否 | String | 实例名称 示例值： test_name |
| MaxTopics | 是 | 否 | Uint64 | 最大可创建主题数量 示例值： 10 |
AMQPQueueDetail
AMQP 队列信息
被如下接口引用：DescribeAMQPQueues
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Name | 是 | 否 | String | Queue名称 示例值： test |
| Remark | 是 | 是 | String | 说明 示例值： 备注 |
| DestBindedNum | 是 | 是 | Uint64 | 被绑定数 示例值： 1 |
| CreateTime | 是 | 是 | Uint64 | 创建时间，以毫秒为单位 示例值： 100000 |
| UpdateTime | 是 | 是 | Uint64 | 创建时间，以毫秒为单位 示例值： 100000 |
| OnlineConsumerNum | 是 | 是 | Uint64 | 在线消费者数 示例值： 20 |
| Tps | 是 | 是 | Uint64 | 每秒钟的事务数 示例值： 120 |
| AccumulativeMsgNum | 是 | 是 | Uint64 | 消息堆积数 示例值： 90 |
| AutoDelete | 是 | 是 | Bool | 是否自动删除 示例值： true |
| DeadLetterExchange | 是 | 是 | String | 死信交换机 示例值： test |
| DeadLetterRoutingKey | 是 | 是 | String | 死信交换机路由键 示例值： test |
ConfigModuleInfoOpt
配置模块
被如下接口引用：DescribeModuleListOpt
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ModuleName | 是 | 否 | String | 模块名 示例值： broker |
| ComponentName | 是 | 否 | String | 组件名 示例值： BROKER |
| ConfigName | 是 | 否 | String | 配置文件名 示例值： broker.conf |
| IsShell | 是 | 否 | Bool | 是否脚本文件 示例值： false |
PublicAccessRule
公网访问安全规则
被如下接口引用：DescribeRocketMQPublicAccessPoint
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| IpRule | 是 | 否 | String | ip网段信息 示例值： 0.0.0.0/0 |
| Allow | 是 | 否 | Bool | 允许或者拒绝 示例值： true |
| Remark | 否 | 是 | String | 备注信息 示例值： test remark info |
Gateway
单元化网关
被如下接口引用：NotifyDeploymentUnitArchChanged
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| BusinessSystemId | 否 | 否 | String | 业务系统 ID 示例值： 无 |
| GatewayId | 否 | 否 | String | 网关 ID 示例值： 无 |
| Vip | 否 | 否 | String | 网关 vip 示例值： 无 |
| Port | 否 | 否 | String | 网关端口 示例值： 无 |
RocketMQTopicConfig
RocketMQ主题配置信息
被如下接口引用：CreateRocketMQMigrationTask、ImportRocketMQTopics
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Namespace | 是 | 否 | String | 命名空间 示例值： test_ns |
| TopicName | 是 | 否 | String | 主题名称 示例值： test_topic |
| Type | 是 | 否 | String | 主题类型： Normal，普通 PartitionedOrder, 分区顺序 Transaction，事务消息 DelayScheduled，延迟/定时消息 示例值： Normal |
| Partitions | 是 | 否 | Int64 | 分区个数 示例值： 3 |
| Remark | 否 | 否 | String | 备注信息 示例值： remark info |
RocketMQRouterRuleInfo
rocketmq router规则基本信息
被如下接口引用：CreateRocketMQRouterRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SourceType | 是 | 否 | String | 源类型。 OPEN_SOURCE_ROCKETMQ：开源rocketmq ALI_ROCKETMQ：阿里云rocketmq TENCENT_ROCKETMQ：腾讯云rocketmq TENCENT_MQTT：腾讯云MQTT ALI_MNS：阿里云mns 示例值： TENCENT_ROCKETMQ |
| TargetType | 是 | 否 | String | 目标类型。 枚举和SourceType字段一样 示例值： TENCENT_ROCKETMQ |
| AliMessageServiceSource | 否 | 否 | RouterMessageServiceSource | 阿里云mns源信息 示例值：查看 |
| AliMessageServiceTarget | 否 | 否 | RouterMessageServiceTarget | 阿里云mns目标信息 示例值：查看 |
| TenRocketMQTarget | 否 | 否 | RouterTencentRocketMQTarget | 腾讯云rocketmq目标信息 示例值：查看 |
| AliasName | 否 | 否 | String | 别名 示例值： - |
| TenMQTTTarget | 否 | 否 | RouterTencentMQTTTarget | 腾讯云 MQTT 目标集群信息 示例值：查看 |
| RemarkName | 否 | 否 | String | 规则备注，创建后任务后可以修改 示例值： - |
| AliRocketMQSource | 否 | 否 | RouterRocketMQSource | 阿里云rocketmq源信息 示例值：查看 |
| AliRocketMQTarget | 否 | 否 | RouterRocketMQTarget | 阿里云rocketmq目标信息 示例值：查看 |
| TenRocketMQSource | 否 | 否 | RouterTencentRocketMQSource | 腾讯云rocketmq源信息 示例值：查看 |
| TenMQTTSource | 否 | 否 | RouterTencentMQTTSource | 腾讯云 MQTT 源集群信息 示例值：查看 |
TopicRecord
主题关键信息
被如下接口引用：DeleteTopics
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| EnvironmentId | 是 | 否 | String | 环境（命名空间）名称。 示例值： devNs |
| TopicName | 是 | 否 | String | 主题名称。 示例值： devTopic |
RouterTencentMQTTTarget
MQTT 目标集群信息
被如下接口引用：CreateRocketMQRouterRule、DeleteRocketMQRouterRule、DescribeRocketMQRouterRuleDetail、DescribeRocketMQRouterRules、UpdateRocketMQRouterRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Endpoint | 否 | 是 | String | MQTT集群接入点信息 示例值： http://mqtt-sk3bsed7.com |
| ClusterId | 是 | 是 | String | MQTT 集群ID 示例值： mqtt-demo123 |
| Topic | 是 | 是 | String | 主题名 示例值： topic_test |
| SourceRegion | 是 | 是 | String | 地域 示例值： ap-guangzhou |
| UserName | 是 | 是 | String | 用户名 示例值： admin |
| Password | 否 | 是 | String | 用户密码 示例值： text-qwe |
| TargetProduceConcurrentThreadCount | 否 | 是 | Int64 | 消费者并发数，0 ～ 100 示例值： 0 |
| FilterFromTimestampMs | 否 | 是 | Int64 | 过滤时间，毫秒时间戳 示例值： 0 |
RouterTencentRocketMQSource
rocketmq router腾讯云源
被如下接口引用：CreateRocketMQRouterRule、DeleteRocketMQRouterRule、DescribeRocketMQRouterRuleDetail、DescribeRocketMQRouterRules、UpdateRocketMQRouterRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SourceConsumeConcurrentThreadCount | 否 | 是 | Int64 | 消费者并发数 示例值： 1 |
| ClusterId | 是 | 是 | String | rocketmq实例id 示例值： rocketmq-xxxxx |
| SourceRegion | 否 | 是 | String | 源地域 示例值： ap-beijing |
| FilterExpression | 是 | 是 | String | 过滤表达式, 参考：https://github.com/apache/rocketmq/blob/develop/common/src/main/java/org/apache/rocketmq/common/filter/ExpressionType.java 示例值： - |
| FilterFromTimestampMs | 是 | 是 | Int64 | 过滤时间，毫秒时间戳 示例值： 1691983398481 |
| FilterType | 是 | 是 | String | 过滤类型，参考：https://github.com/apache/rocketmq/blob/develop/common/src/main/java/org/apache/rocketmq/common/filter/ExpressionType.java 示例值： TAG |
| Namespace | 否 | 是 | String | 4.X的命名空间，没有使用则留空，5.X也留空。 naemspace 需要包含MQ_INST那部分. 比如：MQ_INST_rocketmqka57d53rnn5_tiger_namespace 示例值： - |
| Topic | 是 | 是 | String | topic名字 示例值： - |
Role
角色实例
被如下接口引用：DescribeRocketMQRoles、DescribeRoles
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Secretkey | 否 | 是 | String | secret key 示例值： Zl34bUZYqqsdsdfYaxlrZ |
| PermType | 否 | 否 | String | 授权类型（Cluster：集群；TopicAndGroup：主题或消费组） 示例值： Cluster |
| RoleName | 是 | 否 | String | 角色名称。 示例值： test_role_name |
| Token | 是 | 否 | String | 角色token值。 示例值： eyJrZXlJZCI6InN1bmdvxxxxx0X3JvbGVfMyJ9.dbHR8m6gc4L4vZUrodhW_O9bDulZQ6lraNswNLtcUcY |
| Remark | 是 | 否 | String | 备注说明。 示例值： 测试账号 |
| CreateTime | 是 | 否 | Datetime | 创建时间。 示例值： 2020-09-22 00:00:00 |
| UpdateTime | 是 | 否 | Datetime | 更新时间。 示例值： 2020-09-22 00:00:00 |
AMQPClusterInfo
AMQP集群基本信息
被如下接口引用：DescribeAMQPCluster、DescribeAMQPClusters
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ClusterId | 是 | 否 | String | 集群ID 示例值： amqp-xxxxx |
| ClusterName | 是 | 否 | String | 集群名称 示例值： test |
| Region | 是 | 否 | String | 地域信息 示例值： 某地区 |
| CreateTime | 是 | 否 | Uint64 | 创建时间，毫秒为单位 示例值： 100000000 |
| Remark | 是 | 是 | String | 集群说明信息 示例值： 备注 |
| PublicEndPoint | 是 | 是 | String | 公网接入地址 示例值： xxxx |
| VpcEndPoint | 是 | 是 | String | VPC接入地址 示例值： xxxxx |
RetentionPolicy
消息保留策略
被如下接口引用：CreateEnvironment、DescribeEnvironments、ModifyEnvironmentAttributes
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TimeInMinutes | 是 | 否 | Int64 | 消息保留时长 示例值： 0 |
| SizeInMB | 是 | 否 | Int64 | 消息保留大小 示例值： 0 |
Extension
单元化组件扩展信息
被如下接口引用：NotifyDeploymentUnitArchChanged
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Data | 否 | 否 | String | 扩展数据 示例值： 无 |
| Service | 否 | 否 | String | 组件名称，例如 tsf 示例值： 无 |
CloudSpace
单元化云空间
被如下接口引用：NotifyDeploymentUnitArchChanged
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| CloudSpaceName | 否 | 否 | String | 云空间名称 示例值： 无 |
| CloudId | 否 | 否 | String | TCS ID 示例值： 无 |
| CloudName | 否 | 否 | String | TCS 名称 示例值： 无 |
| RegionId | 否 | 否 | String | 地域 示例值： 无 |
| GDUs | 否 | 否 | Array of GDU | GDU 示例值：查看 |
| Gateways | 否 | 否 | Array of Gateway | 单元化网关 示例值：查看 |
| Extensions | 否 | 否 | Array of Extension | 组件扩展信息 示例值：查看 |
| CustomerIdMappingServiceURL | 否 | 否 | String | 客户号映射服务地址 示例值： 无 |
| CloudSpaceId | 否 | 否 | String | 云空间 ID 示例值： 无 |
| SDUs | 否 | 否 | Array of SDU | SDU 示例值：查看 |
| SDUTrafficRules | 否 | 否 | Array of SDUTrafficRule | 流量路径 示例值：查看 |
| RegionName | 否 | 否 | String | 地域名 示例值： 无 |
| UnbindGatewayIds | 否 | 否 | Array of String | 待解绑的网关 Id， rocketmq目前没有使用这个字段 示例值： 无 |
RouterRocketMQSource
rocketmq router的rocketmq源信息
被如下接口引用：CreateRocketMQRouterRule、DeleteRocketMQRouterRule、DescribeRocketMQRouterRuleDetail、DescribeRocketMQRouterRules、UpdateRocketMQRouterRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Namespace | 否 | 是 | String | 4.X的命名空间，没有使用则留空，5.X也留空。 naemspace 需要包含MQ_INST那部分. 比如：MQ_INST_rocketmxxx57d53rnn5_tiger_namespace 示例值： - |
| Topic | 是 | 是 | String | topic名字 示例值： - |
| SecretKey | 是 | 是 | String | secret key 示例值： - |
| SourceConsumeConcurrentThreadCount | 否 | 是 | Int64 | 消费者并发数，0 ～ 100 示例值： 1 |
| AccessKey | 是 | 是 | String | access key 示例值： - |
| FilterExpression | 是 | 是 | String | 过滤表达式, 参考：https://github.com/apache/rocketmq/blob/develop/common/src/main/java/org/apache/rocketmq/common/filter/ExpressionType.java 示例值： * |
| FilterFromTimestampMs | 是 | 是 | Int64 | 过滤时间，毫秒时间戳 示例值： 1691983398481 |
| FilterType | 是 | 是 | String | 过滤类型，参考：https://github.com/apache/rocketmq/blob/develop/common/src/main/java/org/apache/rocketmq/common/filter/ExpressionType.java 示例值： TAG |
| Group | 是 | 是 | String | 消费者组名。会使用该消费者来消费消息 示例值： xxx-group |
| NameServerAddressList | 是 | 是 | String | namesrv地址列表，也可以是云厂商提供的接入点信息 示例值： 127.0.0.1:9876 |
RouterTencentMQTTSource
待复制的 MQTT 源集群信息
被如下接口引用：CreateRocketMQRouterRule、DeleteRocketMQRouterRule、DescribeRocketMQRouterRuleDetail、DescribeRocketMQRouterRules、UpdateRocketMQRouterRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SourceConsumeConcurrentThreadCount | 否 | 是 | Int64 | 消费者并发数，0 ～ 100 示例值： 0 |
| FilterFromTimestampMs | 否 | 是 | Int64 | 过滤时间，毫秒时间戳 示例值： 0 |
| Endpoint | 否 | 是 | String | MQTT集群接入点信息 示例值： http://mqtt-sk3bsed7.com |
| ClusterId | 是 | 是 | String | MQTT 集群ID 示例值： mqtt-demo123 |
| Topic | 是 | 是 | String | 主题名 示例值： topic_test |
| SourceRegion | 是 | 是 | String | 地域 示例值： ap-guangzhou |
| UserName | 是 | 是 | String | 用户名 示例值： admin |
| Password | 否 | 是 | String | 用户密码 示例值： test-qwe |
RocketMQTopic
RocketMQ主题信息
被如下接口引用：DescribeRocketMQTopic、DescribeRocketMQTopics
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| InstanceId | 是 | 是 | String | 实例ID 示例值： rocketmq-2p9vx3ax9jxg |
| Namespace | 是 | 是 | String | 命名空间 示例值： test_namespace |
| LastUpdateTime | 否 | 是 | Int64 | 最后写入时间，单位为秒 示例值： 1727420571 |
| SubscriptionCount | 否 | 是 | Int64 | 订阅数量 示例值： 10 |
| Type | 是 | 否 | String | 主题的类别，为枚举类型，Normal，GlobalOrder，PartitionedOrder，Transaction，Retry及DeadLetter 示例值： Normal |
| GroupNum | 是 | 否 | Uint64 | 订阅组数量 示例值： 5 |
| Remark | 是 | 是 | String | 说明 示例值： 备注信息 |
| SubscriptionData | 否 | 是 | Array of RocketMQSubscription | 订阅关系列表 示例值：查看 |
| TagList | 否 | 否 | Array of Tag | 绑定的标签列表 示例值：查看 |
| Name | 是 | 否 | String | 主题名称 示例值： test_topic |
| PartitionNum | 是 | 否 | Uint64 | 读写分区数 示例值： 3 |
| CreateTime | 是 | 否 | Uint64 | 创建时间，以毫秒为单位 示例值： 100000 |
| UpdateTime | 是 | 否 | Uint64 | 创建时间，以毫秒为单位 示例值： 100000 |
SendConfigInfoOpt
下发配置结果
被如下接口引用：SendAllModulesConfigOpt、SendConfigOpt
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| NodeIp | 是 | 否 | String | 节点ip地址 示例值： 192.168.1.1 |
| ClusterName | 是 | 否 | String | 集群名 示例值： test-cluster |
| ModuleName | 是 | 是 | String | 模块名 示例值： BROKER |
| ConfigVersion | 是 | 是 | String | 配置版本 示例值： 1 |
| Status | 是 | 否 | Bool | 下发状态 示例值： true |
Environment
命名空间信息
被如下接口引用：DescribeEnvironments
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| EnvironmentId | 是 | 否 | String | 命名空间名称 示例值： devNs |
| Remark | 是 | 否 | String | 说明 示例值： devRemark |
| MsgTTL | 是 | 否 | Int64 | 未消费消息过期时间，单位：秒，最大1296000（15天） 示例值： 2 |
| CreateTime | 是 | 否 | Datetime | 创建时间 示例值： 2020-02-17 00:00:00 |
| UpdateTime | 是 | 否 | Datetime | 最近修改时间 示例值： 2020-02-17 00:00:00 |
| NamespaceId | 是 | 否 | String | 命名空间ID 示例值： devName1 |
| NamespaceName | 是 | 否 | String | 命名空间名称 示例值： devName1 |
| TopicNum | 是 | 是 | Int64 | Topic数量 示例值： 2 |
| RetentionPolicy | 是 | 是 | RetentionPolicy | 消息保留策略 示例值：查看 |
RocketMQMsgLog
rocketmq消息日志
被如下接口引用：DescribeRocketMQTopicMsgs
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| DeadLetterResendTimes | 是 | 是 | Int64 | 死信重发次数 示例值： 10 |
| ResendSuccessCount | 是 | 是 | Int64 | 死信重发成功次数 示例值： 10 |
| MsgId | 是 | 否 | String | 消息id 示例值： 092BAE5A1656070DEA4E276DF0760089 |
| MsgTag | 是 | 是 | String | 消息tag 示例值： test_tag |
| MsgKey | 是 | 是 | String | 消息key 示例值： test_key |
| ProducerAddr | 是 | 否 | String | 客户端地址 示例值： 9.43.174.90 |
| ProduceTime | 是 | 否 | String | 消息发送时间 示例值： 2023-10-08 15:45:16 |
| PulsarMsgId | 是 | 否 | String | pulsar消息id 示例值： 092BAE5A1656070DEA4E276DF0760089 |
RocketMQGroup
RocketMQ消费组信息
被如下接口引用：DescribeRocketMQConsumerConnections、DescribeRocketMQGroups
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Name | 是 | 否 | String | 消费组名称 示例值： test_group |
| TotalAccumulative | 是 | 否 | Int64 | 总堆积数量 示例值： 380 |
| ClientProtocol | 是 | 否 | String | 客户端协议 示例值： tcp |
| RetryMaxTimes | 是 | 是 | Uint64 | 重试次数 示例值： 16 |
| SubscribeTopicNum | 否 | 否 | Int64 | 订阅的主题个数 示例值： 10 |
| ConsumerNum | 是 | 否 | Uint64 | 在线消费者数量 示例值： 2 |
| TPS | 是 | 否 | Uint64 | 消费TPS 示例值： 100 |
| ConsumptionMode | 是 | 否 | Int64 | 0表示集群消费模式，1表示广播消费模式，-1表示未知 示例值： 0 |
| RetryPartitionNum | 是 | 是 | Uint64 | 重试队列分区数 示例值： 2 |
| UpdateTime | 是 | 否 | Uint64 | 修改时间，以毫秒为单位 示例值： 1729478721 |
| Remark | 是 | 是 | String | 说明信息 示例值： 备注信息 |
| ConsumerType | 是 | 是 | String | 消费者类型，枚举值ACTIVELY, PASSIVELY 示例值： PUSH |
| BroadcastEnabled | 是 | 否 | Bool | 是否开启广播消费 示例值： false |
| ReadEnabled | 是 | 否 | Bool | 是否允许消费 示例值： true |
| CreateTime | 是 | 否 | Uint64 | 创建时间，以毫秒为单位 示例值： 1729478721 |
| GroupType | 是 | 是 | String | Group类型 示例值： TCP |
| InstanceId | 是 | 是 | String | 实例ID 示例值： rocketmq-4k4orqgq |
| Namespace | 是 | 是 | String | 命名空间 示例值： test_namespace |
| TagList | 否 | 否 | Array of Tag | 绑定的标签列表 示例值：查看 |
AMQPQueueConsumer
AMQP队列消费者信息
被如下接口引用：DescribeAMQPQueueConsumers
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ClientAddr | 是 | 否 | String | 消费者实例的地址和端口 示例值： 192.168.0.1:5555 |
| ClientTag | 是 | 否 | String | 消费者标签 示例值： consumer1 |
| CreateTime | 是 | 否 | Uint64 | 创建时间，以毫秒为单位 示例值： 100000 |
AMQPExchange
AMQP Exchange信息
被如下接口引用：DescribeAMQPExchanges
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Name | 是 | 否 | String | Exchange名称 示例值： test |
| Type | 是 | 否 | String | Exchange的类别，为枚举类型:Direct, Fanout, Topic 示例值： Default |
| SourceBindedNum | 是 | 否 | Uint64 | 主绑定数 示例值： 1 |
| Remark | 是 | 是 | String | 说明 示例值： 备注 |
| DestBindedNum | 是 | 否 | Uint64 | 被绑定数 示例值： 1 |
| CreateTime | 是 | 否 | Uint64 | 创建时间，以毫秒为单位 示例值： 100000 |
| UpdateTime | 是 | 否 | Uint64 | 创建时间，以毫秒为单位 示例值： 100000 |
| Internal | 是 | 否 | Bool | 是否为内部Exchange(以amq.前缀开头的) 示例值： false |
BindCluster
用户专享集群信息
被如下接口引用：DescribeBindClusters
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ClusterId | 是 | 否 | Int64 | 物理集群的ID 示例值： pulsar-mw4qmgaq298g |
| ClusterName | 是 | 否 | String | 物理集群的名称 示例值： devClusterName |
DeliveryInfoOpt
配置下发状态信息
被如下接口引用：DescribeDeliveryStatusOpt
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| DeliveryIp | 是 | 否 | String | 代理节点IP 示例值： 10.73.13.97 |
| DeliveryTimes | 是 | 是 | Int64 | 下发时间 示例值： 1 |
| DeliveryStatus | 是 | 否 | Int64 | 下发状态（实际大小1字节） 0 下发中 1 陈工 2失败 示例值： 2 |
| ConfigVersion | 是 | 否 | String | 版本 示例值： 1 |
| AddTime | 是 | 否 | Int64 | 新增时间 示例值： 1111 |
ConsumerLog
消费日志
被如下接口引用：DescribeMsgTrace
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| MsgId | 是 | 否 | String | 消息ID。 示例值： 1:1:1 |
| ConsumerGroup | 是 | 否 | String | 消费组。 示例值： group |
| ConsumerName | 是 | 否 | String | 消费组名称。 示例值： name |
| ConsumeTime | 是 | 否 | String | 消费时间。 示例值： 2021-11-02 17:53:00,12,654 |
| ConsumerAddr | 是 | 否 | String | 消费者客户端地址。 示例值： 1.1.1.1 |
| ConsumeUseTime | 是 | 否 | Uint64 | 消费耗时（毫秒）。 示例值： 12 |
| Status | 是 | 否 | String | 消费状态。 示例值： 0 |
TagFilter
标签过滤器
被如下接口引用：DescribeRocketMQGroups、DescribeRocketMQTopics
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TagKey | 是 | 否 | String | 标签键名称 示例值： test_key |
| TagValues | 是 | 否 | Array of String | 标签值列表 示例值： test_value |
RocketMQSubscription
RocketMQ消费组订阅信息
被如下接口引用：DescribeRocketMQSubscriptions、DescribeRocketMQTopic、DescribeRocketMQTopics
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ConsumerGroup | 否 | 是 | String | 消费组名称 示例值： test_group |
| ClientProtocol | 否 | 是 | String | 协议类型 示例值： TCP/HTTP |
| Type | 是 | 是 | String | 主题类型： Normal 普通, GlobalOrder 全局顺序, PartitionedOrder 局部顺序, Transaction 事务消息, DelayScheduled 延时消息, Retry 重试, DeadLetter 死信 示例值： DeadLetter |
| IsOnline | 否 | 是 | Bool | 是否在线 示例值： false |
| ConsumeType | 否 | 是 | Int64 | 消费类型 0: 广播消费 1: 集群消费 示例值： 1 |
| Topic | 是 | 否 | String | 主题名称 示例值： test_topic |
| ConsumerLag | 是 | 是 | Int64 | 消费堆积数量 示例值： 260 |
| ClusterId | 否 | 是 | String | 实例ID 示例值： rocketmq-2p9vx3ax9jxg |
| ClientSubscriptionInfos | 否 | 是 | Array of ClientSubscriptionInfo | 客户端订阅详情 示例值：查看 |
| Consistency | 否 | 是 | Int64 | 订阅一致性 示例值： 1 |
| LastUpdateTime | 否 | 是 | Int64 | 最后消费进度更新时间，秒为单位 示例值： 1727420571 |
| MaxRetryTimes | 否 | 是 | Int64 | 最大重试次数 示例值： 10 |
| PartitionNum | 是 | 是 | Int64 | 分区数 示例值： 3 |
| ExpressionType | 是 | 是 | String | 过滤模式，TAG，SQL 示例值： TAG |
| SubString | 是 | 是 | String | 过滤表达式 示例值： test_tag |
| Status | 是 | 是 | Int64 | 订阅状态： 0，订阅关系一致 1，订阅关系不一致 2，未知 示例值： 0 |
GDU
单元化GDU
被如下接口引用：NotifyDeploymentUnitArchChanged
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Status | 否 | 否 | String | 当前容灾状态 示例值： 无 |
| RemoteDisasterRecoveryCloudSpaceId | 否 | 否 | String | 异地灾备云空间 id 示例值： 无 |
| GDUId | 否 | 否 | String | GDU ID 示例值： 无 |
| ZoneId | 否 | 否 | String | 可用区 示例值： 无 |
| LocalDisasterRecoveryUnitId | 否 | 否 | String | 同城灾备单元 id 示例值： 无 |
| UnitEnvType | 否 | 否 | String | 单元环境类型- prod，gray 示例值： 无 |
| ExcludeZones | 否 | 否 | Array of String | 排除的可用区Id信息, V4新增 示例值： 无 |
| GDUName | 否 | 否 | String | GDU 名称 示例值： 无 |
| ZoneName | 否 | 否 | String | 可用区名 示例值： 无 |
| RemoteDisasterRecoveryUnitId | 否 | 否 | String | 异地灾备单元 id 示例值： 无 |
RocketMQClusterInfo
RocketMQ集群基本信息
被如下接口引用：DescribeRocketMQCluster、DescribeRocketMQClusters
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| PublicEndPoint | 是 | 否 | String | 公网接入地址 示例值： rocketmq.access.public.com:9867 |
| InternalEndpoint | 是 | 是 | String | TCP内部接入地址 示例值： namespace.internal:port |
| HttpInternalEndpoint | 是 | 是 | String | HTTP协议内部接入地址 示例值： http://ip:port |
| InstanceStatus | 否 | 是 | Int64 | 实例状态，0表示创建中，1表示正常，2表示隔离中，3表示已销毁，4 - 异常, 5 - 发货失败，6 - 变配中，7 - 变配失败 示例值： 1 |
| AdminSecretKey | 否 | 是 | String | Admin SK 示例值： sk4ea181d5da |
| RocketMQFlag | 是 | 是 | Bool | Rocketmq集群标识 示例值： false |
| PublicClbId | 否 | 是 | String | 公网CLB实例ID 示例值： clbId |
| Remark | 是 | 是 | String | 集群说明信息 示例值： info-remark |
| HttpPublicEndpoint | 是 | 是 | String | HTTP协议公网接入地址 示例值： http://ip:port |
| AdminFeatureEnabled | 否 | 否 | Bool | 是否开启集群Admin能力 示例值： false |
| ClusterName | 是 | 否 | String | 集群名称 示例值： rocket-order-instance |
| IsolateTime | 是 | 是 | Int64 | 欠费停服时间，毫秒为单位 示例值： 1729478721 |
| ZoneIds | 否 | 是 | Array of Int64 | 集群节点所在的可用区，若该集群为跨可用区集群，则包含该集群节点所在的多个可用区。 示例值： [100001] |
| NamePattern | 否 | 是 | String | 名称格式 示例值： STARAND |
| IsFrozen | 否 | 否 | Bool | 是否已冻结 示例值： false |
| SupportNamespaceEndpoint | 是 | 是 | Bool | 是否支持命名空间接入点 示例值： true |
| HttpVpcEndpoint | 是 | 是 | String | HTTP协议VPC接入地址 示例值： http://ip:port |
| AdminAccessKey | 否 | 是 | String | Admin AK 示例值： ak5pe5ae0cca |
| Vip | 否 | 是 | String | vip 示例值： vip |
| AutoCreateTopicEnabled | 否 | 否 | Bool | 是否开启自动创建主题 示例值： false |
| EnableDeletionProtection | 否 | 否 | Bool | 是否开启删除保护 示例值： false |
| Vpcs | 是 | 是 | Array of VpcConfig | VPC信息 示例值：查看 |
| IsVip | 是 | 是 | Bool | 是否为专享实例 示例值： false |
| Status | 是 | 是 | Int64 | 计费状态，1表示正常，2表示已停服，3表示已销毁 示例值： 1 |
| AclEnabled | 是 | 是 | Bool | 是否开启ACL鉴权，专享实例支持关闭 示例值： true |
| SupportMigration | 否 | 是 | Bool | 是否支持迁移 示例值： false |
| ZoneId | 否 | 是 | Int64 | 集群所属可用区，表明集群归属的可用区 示例值： 100001 |
| ClusterId | 是 | 否 | String | 集群ID 示例值： rocketmq-4k4orqgq |
| Region | 是 | 否 | String | 地域信息 示例值： 华南地区 |
| CreateTime | 是 | 否 | Uint64 | 创建时间，毫秒为单位 示例值： 1729478721 |
| VpcEndPoint | 是 | 否 | String | VPC接入地址 示例值： rocketmq.resource.vpc.com:5010 |
| VpcId | 否 | 是 | String | 所属VPC 示例值： mqvpc296 |
TemplateItemInfoOpt
模板配置项
被如下接口引用：DescribeTemplateItemOpt
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ItemKey | 是 | 否 | String | 配置属性名 示例值： key |
| ItemDefaultValue | 是 | 是 | String | 配置项默认值 示例值： value |
| ItemValue | 是 | 是 | String | 模板配置项值 示例值： value |
| ItemDesc | 是 | 是 | String | 描述 示例值： desc |
| IsDynamic | 是 | 否 | Bool | 是否动态配置，0需要重启，1不需要重启 示例值： 0 |
ConsumerLogs
消费信息
被如下接口引用：DescribeMsgTrace
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TotalCount | 是 | 是 | Uint64 | 记录数。 示例值： 1 |
| ConsumerLogSets | 是 | 是 | Array of ConsumerLog | 消费日志。 示例值：查看 |
AMQPVHost
vhostd信息
被如下接口引用：DescribeAMQPVHosts
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VHostId | 是 | 否 | String | 命名空间名称，3-64个字符，只能包含字母、数字、“-”及“_” 示例值： prod |
| MsgTtl | 是 | 否 | Uint64 | 未消费消息的保留时间，以毫秒单位，范围60秒到15天 示例值： 100000 |
| Remark | 是 | 是 | String | 备注 示例值： 备注 |
| CreateTime | 是 | 否 | Uint64 | 创建时间，以毫秒为单位 示例值： 100000 |
| UpdateTime | 是 | 否 | Uint64 | 更新时间，以毫秒为单位 示例值： 100000 |
| Username | 是 | 否 | String | 用户名 示例值： xxxxx |
| Password | 是 | 否 | String | 密码 示例值： xxxxxx |
ConfigDictItemOpt
配置项字典
被如下接口引用：DescribeConfigDictOpt
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ItemKey | 是 | 否 | String | 配置项Key 示例值： clientPort |
| ItemDefaultValue | 是 | 否 | String | 配置项默认值 示例值： 2181 |
| ItemDesc | 是 | 否 | String | 配置项描述 示例值： Item |
| IsDynamic | 是 | 否 | Bool | 是否动态生成 示例值： false |
Filter
过滤参数
被如下接口引用：DescribeEnvironmentRoles、DescribeEnvironments、DescribeInternalRocketMQInstances、DescribeInternalRocketMQNamespaces、DescribeRocketMQClusters、DescribeRocketMQEnvironmentRoles、DescribeRocketMQMigrateTopicAccessInfo、DescribeRocketMQMigrationTaskDetail、DescribeRocketMQMigrationTasks、DescribeRocketMQRoles、DescribeRocketMQVipInstances、DescribeRoles、DescribeTopics
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Name | 否 | 否 | String | 过滤参数的名字 示例值： paramName |
| Values | 否 | 否 | Array of String | 数值 示例值： ["a"] |
AMQPClusterRecentStats
AMQP集群近期使用量
被如下接口引用：DescribeAMQPCluster
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| QueueNum | 是 | 否 | Uint64 | Queue数量 示例值： 20 |
| ProducedMsgNum | 是 | 否 | Uint64 | 消息生产数 示例值： 11000 |
| AccumulativeMsgNum | 是 | 否 | Uint64 | 消息堆积数 示例值： 22000 |
| ExchangeNum | 是 | 否 | Uint64 | Exchange数量 示例值： 20 |
ProducerLog
消息生产信息
被如下接口引用：DescribeMsgTrace
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| MsgId | 是 | 否 | String | 消息ID。 示例值： 6054156:22067:16 |
| ProducerName | 否 | 否 | String | 生产者名称。 示例值： pulsar-7dqvnqwjgzm-2156-9 |
| ProduceTime | 是 | 否 | String | 消息生产时间。 示例值： 2024-10-08 14:45:52,636 |
| ProduceUseTime | 是 | 否 | Uint64 | 生产耗时（秒）。 示例值： 2 |
| Status | 是 | 否 | String | 状态。 示例值： success |
SDU
单元化SDU
被如下接口引用：NotifyDeploymentUnitArchChanged
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ZoneId | 否 | 否 | String | 可用区 示例值： 无 |
| ZoneName | 否 | 否 | String | 可用去名 示例值： 无 |
| RemoteDisasterRecoveryCloudSpaceId | 否 | 否 | String | 异地灾备云空间 id 示例值： 无 |
| UnitEnvType | 否 | 否 | String | 单元环境类型- prod，gray 示例值： 无 |
| SDUId | 否 | 否 | String | SDU ID 示例值： 无 |
| SDUName | 否 | 否 | String | SDU 名称 示例值： 无 |
| LocalDisasterRecoveryUnitId | 否 | 否 | String | 同城灾备单元 id 示例值： 无 |
| RemoteDisasterRecoveryUnitId | 否 | 否 | String | 异地灾备单元 id 示例值： 无 |
| Status | 否 | 否 | String | 当前容灾状态 示例值： 无 |
RocketMQTopicDistribution
RocketMQtopic分布情况
被如下接口引用：DescribeRocketMQCluster、DescribeRocketMQClusters
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TopicType | 是 | 否 | String | topic类型 示例值： Normal |
| Count | 是 | 否 | Uint64 | topic数量 示例值： 10 |
RocketMQClusterRecentStats
RocketMQ近期使用量
被如下接口引用：DescribeRocketMQCluster
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TopicNum | 是 | 否 | Uint64 | Topic数量 示例值： 20 |
| ApiRequestNum | 是 | 否 | Uint64 | API请求数 示例值： 538000 |
| ProducedMsgNum | 是 | 否 | Uint64 | 消息生产数 示例值： 11000 |
| ConsumedMsgNum | 是 | 否 | Uint64 | 消息消费数 示例值： 11200 |
| AccumulativeMsgNum | 是 | 否 | Uint64 | 消息堆积数 示例值： 22000 |
ConfigTemplateItemOpt
模板配置项
被如下接口引用：CreateTemplateItemsOpt
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ItemKey | 是 | 否 | String | 配置属性 示例值： key |
| ItemValue | 是 | 否 | String | 属性值 示例值： value |
| ItemDesc | 否 | 否 | String | 配置项备注 示例值： desc |
| IsDynamic | 否 | 否 | Bool | 是否动态配置 示例值： true |
DeploymentUnitHealthStatusResult
DeploymentUnitHealthStatus返回值
被如下接口引用：DescribeDeploymentUnitHealthStatus
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Enabled | 否 | 是 | Bool | 是否启用单元化 示例值： 无 |
| Data | 否 | 是 | String | 扩展信息 示例值： 无 |
AMQPClusterConfig
AMQP集群配置
被如下接口引用：DescribeAMQPCluster、DescribeAMQPClusters
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| MaxTpsPerVHost | 是 | 否 | Uint64 | 单Vhost TPS上限 示例值： 8000 |
| MaxConnNumPerVHost | 是 | 否 | Uint64 | 单Vhost客户端连接数上限 示例值： 8000 |
| MaxVHostNum | 是 | 否 | Uint64 | 最大Vhost数量 示例值： 10 |
| MaxExchangeNum | 是 | 否 | Uint64 | 最大exchange数量 示例值： 100 |
| MaxQueueNum | 是 | 否 | Uint64 | 最大Queue数量 示例值： 100 |
| MaxRetentionTime | 是 | 否 | Uint64 | 消息最大保留时间，以毫秒为单位 示例值： 100000 |
| UsedVHostNum | 是 | 否 | Uint64 | 已使用Vhost数量 示例值： 3 |
| UsedExchangeNum | 是 | 否 | Uint64 | 已使用exchange数量 示例值： 3 |
| UsedQueueNum | 是 | 否 | Uint64 | 已使用queue数量 示例值： 8 |
EnvironmentRoleSet
角色批量绑定命名空间信息
被如下接口引用：CreateRole、ModifyRole
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| EnvironmentId | 是 | 否 | String | 命名空间Id 示例值： devNs |
| Permissions | 是 | 否 | Array of String | 权限枚举值 示例值： ["produce"] |
| ClusterId | 否 | 是 | String | 绑定的集群Id 示例值： pulsar-jmw4o94a3z82 |
| RoleName | 否 | 是 | String | 角色名字 示例值： role-a |
DisasterRecoveryUnit
容灾单元
被如下接口引用：NotifyDisasterRecoveryUnit
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RemoteDisasterRecoveryUnitId | 否 | 是 | String | 异地灾备单元 id 示例值： unit-01 |
| Status | 否 | 是 | String | 容灾状态NORMAL—正常(恢复)LOCAL_DISASTER_RECOVERY—同城容灾REMOTE_DISASTER_RECOVERY—异地容灾 示例值： NORMAL |
| CloudSpaceId | 否 | 是 | String | 云空间 ID(非必填) 示例值： cloud-01 |
| RemoteDisasterRecoveryCloudSpaceId | 否 | 是 | String | 异地灾备云空间 id 示例值： cloud-01 |
| CloudId | 否 | 是 | String | 云空间名称 示例值： clould-01 |
| RegionId | 否 | 是 | String | 地域 ID 示例值： ap-chengdu |
| UnitId | 否 | 是 | String | 单元 ID 示例值： unit-01 |
| LocalDisasterRecoveryUnitId | 否 | 是 | String | 同城灾备单元 id 示例值： unit-01 |
| CurrentDisasterRecoveryUnitId | 否 | 是 | String | 当前容灾单元 Id 示例值： unit-01 |
| ExcludeZones | 否 | 是 | Array of String | 排除流量的可用区 ID 示例值： [az1Id,az2Id] |
RouteRecord
路由记录
被如下接口引用：DescribeRoute
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcId | 是 | 是 | String | 私有网络 示例值： xxx |
| SubnetId | 是 | 是 | String | 子网id 示例值： xxx |
| RouterId | 是 | 否 | String | 路由id 示例值： pulsar-xxx |
| Vip | 是 | 否 | String | vip地址 示例值： 10.10.10.10 |
| Vport | 是 | 否 | Uint64 | vport记录 示例值： 6000 |
| Remark | 是 | 是 | String | 备注信息 示例值： xxx |
| NetType | 是 | 否 | Uint64 | 路由类型 1: 公网 2：vpc 4：支撑网 示例值： 1 |
| Id | 否 | 否 | Uint64 | 路由Id（int 类型） 示例值： route-ID |
RocketMQConsumerTopic
消费者详情中的主题信息
被如下接口引用：DescribeRocketMQConsumerConnectionDetail
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Accumulative | 是 | 否 | Int64 | 消息堆积数 示例值： 100 |
| LastConsumptionTime | 是 | 否 | Uint64 | 最后消费时间，以毫秒为单位 示例值： 1697945990000 |
| SubRule | 是 | 是 | String | 订阅规则 示例值： test_tag |
| Topic | 是 | 否 | String | 主题名称 示例值： test_topic |
| Type | 是 | 否 | String | 主题类型，Normal表示普通，GlobalOrder表示全局顺序，PartitionedOrder表示局部顺序，Transaction表示事务，Retry表示重试，DeadLetter表示死信 示例值： Normal |
| PartitionNum | 是 | 否 | Uint64 | 分区数 示例值： 3 |
RocketMQClusterConfig
RocketMQ集群配置
被如下接口引用：DescribeRocketMQCluster、DescribeRocketMQClusters
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| MaxNamespaceNum | 是 | 否 | Uint64 | 最大命名空间数量 示例值： 10 |
| UsedNamespaceNum | 是 | 否 | Uint64 | 已使用命名空间数量 示例值： 3 |
| MaxTopicNum | 是 | 否 | Uint64 | 最大Topic数量 示例值： 1000 |
| UsedTopicNum | 是 | 否 | Uint64 | 已使用Topic数量 示例值： 8 |
| UsedGroupNum | 是 | 否 | Uint64 | 已使用Group数量 示例值： 10 |
| MaxRetentionTime | 是 | 否 | Uint64 | 消息最大保留时间，以毫秒为单位 示例值： 100000 |
| MaxTpsLimit | 否 | 否 | Int64 | TPS限额 示例值： 4000 |
| MaxTpsPerNamespace | 是 | 否 | Uint64 | 单命名空间TPS上限 示例值： 8000 |
| MaxGroupNum | 是 | 否 | Uint64 | 最大Group数量 示例值： 10000 |
| MaxLatencyTime | 是 | 否 | Uint64 | 消息最长延时，以毫秒为单位 示例值： 100000 |
| MaxQueuesPerTopic | 是 | 是 | Uint64 | 单个主题最大队列数 示例值： 16 |
| TopicDistribution | 是 | 是 | Array of RocketMQTopicDistribution | topic分布 示例值：查看 |
| MaxRoleNum | 否 | 否 | Int64 | 最大角色数量 示例值： 100 |
AMQPRouteRelation
AMQP路由关系
被如下接口引用：DescribeAMQPRouteRelations
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RouteRelationId | 是 | 否 | String | 路由关系ID 示例值： test |
| SourceExchange | 是 | 否 | String | 源Exchange 示例值： xxx |
| DestType | 是 | 否 | String | 目标类型:Queue |
| DestValue | 是 | 否 | String | 目标值 示例值： queue1 |
| RoutingKey | 是 | 否 | String | 绑定key 示例值： xxxc |
| SourceExchangeType | 是 | 否 | String | 源路由类型:Direct |
| CreateTime | 是 | 否 | Uint64 | 创建时间，以毫秒为单位 示例值： 10000 |
| UpdateTime | 是 | 否 | Uint64 | 修改时间，以毫秒为单位 示例值： 修改时间 |
| Remark | 是 | 是 | String | 说明信息 示例值： 备注 |
Cluster
集群信息集合
被如下接口引用：DescribeClusterDetail、DescribeClusters
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ClusterId | 是 | 否 | String | 集群Id。 示例值： 1000 |
| ClusterName | 是 | 否 | String | 集群名称。 示例值： pulsar-47emajijmazk |
| Remark | 是 | 否 | String | 说明信息。 示例值： devInfo |
| EndPointNum | 是 | 否 | Int64 | 接入点数量 示例值： 0 |
| CreateTime | 是 | 否 | String | 创建时间 示例值： 2021-04-21 19:00:00 |
| Healthy | 是 | 否 | Int64 | 集群是否健康，1表示健康，0表示异常 示例值： 1 |
| HealthyInfo | 是 | 是 | String | 集群健康信息 示例值： healthy |
| Status | 是 | 否 | Int64 | 集群状态，0:创建中，1:正常，2:删除中，3:已删除，5:创建失败，6: 删除失败 示例值： 1 |
| MaxNamespaceNum | 是 | 否 | Int64 | 最大命名空间数量 示例值： 100 |
| MaxTopicNum | 是 | 否 | Int64 | 最大Topic数量 示例值： 8000 |
| MaxQps | 是 | 否 | Int64 | 最大QPS 示例值： 1000 |
| MessageRetentionTime | 是 | 否 | Int64 | 消息保留时间 示例值： 100000000 |
| MaxStorageCapacity | 是 | 否 | Int64 | 最大存储容量 示例值： 1024 |
| Version | 是 | 是 | String | 集群版本 示例值： 2.5.1 |
| PublicEndPoint | 是 | 是 | String | 公网访问接入点 示例值： http://pulsar-45epqe3j7jvz.sap-8iutas0k.tdmq.ap-gz.qcloud.xxx.com:8080 |
| VpcEndPoint | 是 | 是 | String | VPC访问接入点 示例值： http://pulsar-45epqe3j7jvz.sap-8iutas0k.tdmq.ap-gz.qcloud.xxx.com:8080 |
| NamespaceNum | 是 | 是 | Int64 | 命名空间数量 示例值： 2 |
| UsedStorageBudget | 是 | 是 | Int64 | 已使用存储限制，MB为单位 示例值： 0 |
| ProjectId | 否 | 是 | String | 资源对应项目id 示例值： 251198839 |
| ProjectName | 否 | 是 | String | 资源对应项目名称 示例值： product01 |
| PayMode | 是 | 否 | Int64 | 计费模型0:按量计费，1：包年包月 示例值： 0 |
| MaxPublishRateInMessages | 否 | 是 | Int64 | 最大生产消息速率，以条数为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值： 1 |
| PclusterName | 否 | 是 | String | 集群名字 示例值： test-Id |
| PublicAccessEnabled | 否 | 是 | Bool | 是否开启公网访问，不填时默认开启 注意：此字段可能返回 null，表示取不到有效值。 示例值： true |
| MaxDispatchRateInBytes | 否 | 是 | Int64 | 命名空间最大消费带宽，byte为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值： 1 |
| Tags | 否 | 是 | Array of Tag | 标签 示例值：查看 |
| TopicNum | 否 | 否 | Int64 | topic数量 示例值： 1 |
| InternalEndPoint | 否 | 是 | String | 内部接入点 示例值： pulsar://1.1.1.1:6650 |
| MaxDispatchRateInMessages | 否 | 是 | Int64 | 最大推送消息速率，以条数为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值： 1 |
| InternalPulsarEndPoint | 否 | 是 | String | 内部pulsar-sdk接入地址 示例值： pulsar://tdmq.ap-gz.xxx.com:6650 |
| MaxPublishRateInBytes | 否 | 是 | Int64 | 最大生产消息速率，以字节为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值： 1 |
| MaxMessageDelayInSeconds | 否 | 是 | Int64 | 最长消息延时，以秒为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值： 1 |
| InternalHttpEndPoint | 否 | 是 | String | 内部http接入地址 示例值： http://tdmq.ap-gz.xxx.com:8080 |
ConfigBaseInfoOpt
集群配置基础信息
被如下接口引用：CreateConfigOpt、DescribeAllVersionConfigsOpt、DescribeClusterConfigOpt
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ClusterName | 是 | 否 | String | 集群名称 示例值： tdmq_txy_gz_01 |
| ModuleName | 是 | 否 | String | 模块名称 示例值： BROKER |
| ConfigVersion | 是 | 否 | String | 配置版本 示例值： 1 |
| RootPath | 是 | 是 | String | 程序路径 示例值： /usr |
| DataPath | 是 | 是 | String | 数据路径 示例值： /usr |
| ConfigPath | 是 | 是 | String | 配置路径 示例值： /usr |
| ConfigName | 是 | 是 | String | 配置文件名 示例值： broker.conf |
ServerLog
服务方信息
被如下接口引用：DescribeMsgTrace
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SaveTime | 是 | 否 | String | 存储时间。 示例值： 2024-10-08 11:38:48,068 |
| Status | 是 | 否 | String | 状态。 示例值： success |
RouterTencentRocketMQTarget
rocketmq router腾讯云目标
被如下接口引用：CreateRocketMQRouterRule、DeleteRocketMQRouterRule、DescribeRocketMQRouterRuleDetail、DescribeRocketMQRouterRules、UpdateRocketMQRouterRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ClusterId | 是 | 是 | String | rocketmq实例id 示例值： rocketmq-xxxxx |
| TargetRegion | 否 | 是 | String | 目标region 示例值： ap-beijing |
| Namespace | 否 | 是 | String | 4.X的命名空间，没有使用则留空，5.X也留空。 naemspace 需要包含MQ_INST那部分. 比如：MQ_INST_rocket2mq3ka57d53rnn5_tiger_namespace 示例值： - |
| Topic | 是 | 是 | String | topic名字 示例值： - |
| TargetProduceConcurrentThreadCount | 否 | 是 | Int64 | 消费者并发数 示例值： 1 |
EditableTarget
RocketMQ Router可编辑的目标信息
被如下接口引用：UpdateRocketMQRouterRule
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AccessKey | 否 | 否 | String | 新的access key 示例值： - |
| SecretKey | 否 | 否 | String | 新的secret key 示例值： - |
FilterSubscription
过滤订阅列表
被如下接口引用：DescribeSubscriptions
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ConsumerHasCount | 否 | 否 | Bool | 是否仅展示包含真实消费者的订阅。 示例值： false |
| ConsumerHasBacklog | 否 | 否 | Bool | 是否仅展示消息堆积的订阅。 示例值： false |
| ConsumerHasExpired | 否 | 否 | Bool | 是否仅展示存在消息超期丢弃的订阅。 示例值： false |
| SubscriptionNames | 否 | 否 | Array of String | 按照订阅名过滤，精确查询。 示例值： false |
SDUTrafficRule
单元化流量路径
被如下接口引用：NotifyDeploymentUnitArchChanged
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SDUId | 否 | 否 | String | SDU ID 示例值： 无 |
| CloudSpaceId | 否 | 否 | String | 云空间 ID 示例值： 无 |
| GDUId | 否 | 否 | String | GDU ID 示例值： 无 |
ConsumersSchedule
消费进度详情
被如下接口引用：DescribeSubscriptions
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Partitions | 是 | 是 | Uint64 | 当前分区id。 示例值： 1 |
| NumberOfEntries | 是 | 是 | Uint64 | 消息数量。 示例值： 1000 |
| MsgBacklog | 是 | 是 | Uint64 | 消息积压数量。 示例值： 2 |
| MsgRateOut | 是 | 否 | String | 消费者每秒分发消息的数量之和。 示例值： 0.0 |
| MsgThroughputOut | 是 | 否 | String | 消费者每秒消息的byte。 示例值： 0.0 |
| MsgRateExpired | 是 | 是 | String | 超时丢弃比例。 示例值： 0.0 |
ResourceProjectInfo
新增或修改资源对应的项目，新增时 oldProjectid 为空，修改时oldProjectId 为当前资源对应的 projectId
被如下接口引用：TpoModifyResourceProject
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ResourceId | 是 | 否 | String | 资源id 示例值： pulasr-11123 |
| OldProjectId | 否 | 否 | String | 旧项目id 示例值： pr-106602ce |
| NewProjectId | 是 | 否 | String | 新项目id 示例值： pr-106602ce7 |
RocketMQMigrationTask
RocketMQ迁移任务信息
被如下接口引用：DescribeRocketMQMigrationTasks
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TopicNum | 是 | 否 | Int64 | 主题总数 示例值： 10 |
| GroupNum | 是 | 否 | Int64 | 消费组总数 示例值： 10 |
| CreateTime | 是 | 否 | Uint64 | 创建时间，单位毫秒 示例值： 1000 |
| Status | 是 | 否 | Int64 | 任务状态： 0，迁移中 1，迁移成功 2，迁移完成，只有部分数据完成迁移 示例值： 0 |
| TaskId | 是 | 否 | String | 任务id 示例值： xxxx |
| Namespace | 是 | 是 | String | 导入的命名空间 示例值： xxxx |
| ClusterId | 是 | 否 | String | 集群id 示例值： rocketmq-xxx |
| Type | 是 | 否 | Int64 | 任务类型： 0，集群迁移 1，导入指定的命名空间 示例值： 0 |
MsgLog
消息日志
被如下接口引用：DescribeTopicMsgs
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| MsgId | 否 | 是 | String | 消息ID。 示例值： 931087:81:0 |
| ProducerName | 否 | 是 | String | 生产者名称。 示例值： devProducerName |
| ProduceTime | 否 | 是 | String | 生产时间。 示例值： 2024-10-08 08:04:13,809 |
| ProducerAddr | 否 | 是 | String | 生产客户端地址。 示例值： 10.0.0.120:38168 |