ConsumeGroupItem
消费组信息
被如下接口引用：DescribeConsumerGroupList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| InstanceId | String | 否 | 实例ID 示例值：req-123456 |
| ConsumerGroup | String | 否 | 消费组名称 示例值：group1 |
| ConsumeEnable | Boolean | 否 | 是否开启消费 示例值：true |
| ConsumeMessageOrderly | Boolean | 否 | 顺序投递：true 并发投递：false 示例值：true |
| MaxRetryTimes | Integer | 否 | 最大重试次数 示例值：3 |
| Remark | String | 否 | 备注 示例值：remark1 |
| ClusterIdV4 | String | 否 | 4.x的集群ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：cluster1 |
| NamespaceV4 | String | 否 | 4.x的命名空间 注意：此字段可能返回 null，表示取不到有效值。 示例值：namespace |
| ConsumerGroupV4 | String | 否 | 4.x的消费组名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：group1 |
| FullNamespaceV4 | String | 否 | 4.x的完整命名空间 注意：此字段可能返回 null，表示取不到有效值。 示例值：namespace |
ConsumerClient
消费者客户端
被如下接口引用：DescribeConsumerClient。
| 名称 | 类型 | 描述 |
|---|---|---|
| ClientId | String | 客户端ID 示例值：11.139.244.248@75043#6734858812769343 |
| ClientAddr | String | 客户端地址 示例值：11.139.244.248 |
| Language | String | 客户端SDK语言 示例值：JAVA |
| Version | String | 客户端SDK版本 示例值：V4_9_3 |
| ConsumerLag | Integer | 客户端消费堆积 注意：此字段可能返回 null，表示取不到有效值。 示例值：100 |
CustomMapEntry
map结构返回
被如下接口引用：DescribeMQTTMessage。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Key | String | 否 | key 注意：此字段可能返回 null，表示取不到有效值。 示例值：key1 |
| Value | String | 否 | value 注意：此字段可能返回 null，表示取不到有效值。 示例值：value1 |
DetailedRolePerm
Topic&Group维度的权限配置
被如下接口引用：CreateRole, DescribeRoleList, ModifyRole。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Resource | String | 是 | 权限对应的资源 示例值：test_topic |
| PermWrite | Boolean | 是 | 是否开启生产权限 示例值：true |
| PermRead | Boolean | 是 | 是否开启消费权限 示例值：true |
| ResourceType | String | 是 | 授权资源类型（Topic:主题; Group:消费组） 示例值：Topic |
| Remark | String | 否 | 资源备注 示例值：test_remark |
Endpoint
接入点信息
被如下接口引用：DescribeInstance。
| 名称 | 类型 | 描述 |
|---|---|---|
| Type | String | 接入点类型，枚举值如下 VPC: VPC; PUBLIC: 公网; INTERNAL: 支撑网; 示例值：VPC |
| Status | String | 状态， OPEN 开启， CLOSE 关闭， PROCESSING 操作中， 示例值：OPEN |
| PayMode | String | 付费类型，仅公网 PREPAID 包年包月 POSTPAID 按量付费 注意：此字段可能返回 null，表示取不到有效值。 示例值：PREPAID |
| EndpointUrl | String | 接入点地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：127.0.0.1 |
| VpcId | String | VPC ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：vpc-5se8xco1 |
| SubnetId | String | 子网ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：subnet-pyspldq0 |
| Bandwidth | Integer | 公网带宽，Mbps为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
| IpRules | Array of IpRule | 公网放通规则 注意：此字段可能返回 null，表示取不到有效值。 示例值：[ { "Ip": "0.0.0.0/1", "Allow": true, "Remark": "全部放通" } ] |
| BillingFlow | Boolean | 公网是否按流量计费 注意：此字段可能返回 null，表示取不到有效值。 示例值：false |
Filter
查询过滤器
被如下接口引用：DescribeConsumerClient, DescribeConsumerGroupList, DescribeFusionInstanceList, DescribeInstanceList, DescribeMQTTInstanceList, DescribeMQTTTopicList, DescribeMQTTUserList, DescribeRoleList, DescribeTopic, DescribeTopicList, DescribeTopicListByGroup。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 是 | 过滤条件参数名 示例值：fliter_key |
| Values | Array of String | 是 | 过滤条件的值 示例值：filter_value |
FusionInstanceItem
实例列表页中的实例信息
被如下接口引用：DescribeFusionInstanceList。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例ID 示例值：rmq-9j7ooebv |
| InstanceName | String | 实例名称 示例值：test_name |
| Version | String | 实例版本 示例值：5.0 |
| InstanceType | String | 实例类型， EXPERIMENT，体验版 BASIC，基础版 PRO，专业版 PLATINUM，铂金版 示例值：BASIC |
| InstanceStatus | String | 实例状态， RUNNING, 运行中 MAINTAINING，维护中 ABNORMAL，异常 OVERDUE，欠费 DESTROYED，已删除 CREATING，创建中 MODIFYING，变配中 CREATE_FAILURE，创建失败 MODIFY_FAILURE，变配失败 DELETING，删除中 示例值：RUNNING |
| TopicNumLimit | Integer | 实例主题数上限 示例值：100 |
| GroupNumLimit | Integer | 实例消费组数量上限 示例值：100 |
| PayMode | String | 计费模式， POSTPAID，按量计费 PREPAID，包年包月 示例值：0 |
| ExpiryTime | Integer | 到期时间，秒为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：100000 |
| Remark | String | 备注信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：remark info |
| TopicNum | Integer | 主题数量 示例值：100 |
| GroupNum | Integer | 消费组数量 示例值：1000 |
| TagList | Array of Tag | 标签列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：[ { "TagKey": "test_key", "TagValue": "test_value" } ] |
| SkuCode | String | 商品规格 示例值：basic_1k |
| TpsLimit | Integer | TPS限流值 注意：此字段可能返回 null，表示取不到有效值。 示例值：2000 |
| ScaledTpsLimit | Integer | 弹性TPS限流值 注意：此字段可能返回 null，表示取不到有效值。 示例值：500 |
| MessageRetention | Integer | 消息保留时间，小时为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：72 |
| MaxMessageDelay | Integer | 延迟消息最大时长，小时为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：960 |
| RenewFlag | Integer | 是否自动续费 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| InstanceItemExtraInfo | InstanceItemExtraInfo | 4.x独有数据 注意：此字段可能返回 null，表示取不到有效值。 示例值：{ "IsVip": true, "InstanceStatus": 1, "VipInstanceStatus": 1, "MaxBandWidth": 80, "NodeCount": 2, "MaxStorage": 200, "SpecName": "rocket-vip-basic-0", "MaxRetention": 168, "MinRetention": 24 } |
| DestroyTime | Integer | 预销毁时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1730710586538 |
InstanceItem
实例列表页中的实例信息
被如下接口引用：DescribeInstanceList。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例ID 示例值：rmq-xxxx |
| InstanceName | String | 实例名称 示例值：test_name |
| Version | String | 实例版本 示例值：5.0 |
| InstanceType | String | 实例类型， EXPERIMENT，体验版 BASIC，基础版 PRO，专业版 PLATINUM，铂金版 示例值：EXPERIMENT |
| InstanceStatus | String | 实例状态， RUNNING, 运行中 MAINTAINING，维护中 ABNORMAL，异常 OVERDUE，欠费 DESTROYED，已删除 CREATING，创建中 MODIFYING，变配中 CREATE_FAILURE，创建失败 MODIFY_FAILURE，变配失败 DELETING，删除中 示例值：RUNNING |
| TopicNumLimit | Integer | 实例主题数上限 示例值：100 |
| GroupNumLimit | Integer | 实例消费组数量上限 示例值：100 |
| PayMode | String | 计费模式， POSTPAID，按量计费 PREPAID，包年包月 示例值：0 |
| ExpiryTime | Integer | 到期时间，秒为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：100000 |
| Remark | String | 备注信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：remark info |
| TopicNum | Integer | 主题数量 示例值：100 |
| GroupNum | Integer | 消费组数量 示例值：1000 |
| TagList | Array of Tag | 标签列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：[ { "TagKey": "test_key", "TagValue": "test_value" } ] |
| SkuCode | String | 商品规格 示例值：basic_1k |
| TpsLimit | Integer | TPS限流值 注意：此字段可能返回 null，表示取不到有效值。 示例值：1000 |
| ScaledTpsLimit | Integer | 弹性TPS限流值 注意：此字段可能返回 null，表示取不到有效值。 示例值：1000 |
| MessageRetention | Integer | 消息保留时间，小时为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：72 |
| MaxMessageDelay | Integer | 延迟消息最大时长，小时为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：960 |
| RenewFlag | Integer | 是否自动续费 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
InstanceItemExtraInfo
4.x集群和5.0集群列表统一显示 4.x特殊数据承载接口
被如下接口引用：DescribeFusionInstanceList。
| 名称 | 类型 | 描述 |
|---|---|---|
| IsVip | Boolean | 是否vip 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| VipInstanceStatus | Integer | 4.x专享集群状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| MaxBandWidth | Integer | 专享集群峰值带宽 注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
| SpecName | String | 专享集群规格 注意：此字段可能返回 null，表示取不到有效值。 示例值：rocket-vip-basic-0 |
| NodeCount | Integer | 专享集群节点数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
| MaxStorage | Integer | 专享集群最大存储 注意：此字段可能返回 null，表示取不到有效值。 示例值：400 |
| MaxRetention | Integer | 专享集群最大保留时间，单位：小时 注意：此字段可能返回 null，表示取不到有效值。 示例值：72 |
| MinRetention | Integer | 专项集群最大保留时间，单位：小时 注意：此字段可能返回 null，表示取不到有效值。 示例值：24 |
| InstanceStatus | Integer | 4.0共享集群状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
IpRule
IP规则
被如下接口引用：CreateInstance, CreateMQTTInstance, DescribeInstance, ModifyInstanceEndpoint。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Ip | String | 是 | IP地址 示例值：0.0.0.0 |
| Allow | Boolean | 是 | 是否允许放行 示例值：true |
| Remark | String | 是 | 备注信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：remark1 |
MQTTClientSubscription
MQTT 订阅关系
被如下接口引用：DescribeMQTTClient。
| 名称 | 类型 | 描述 |
|---|---|---|
| TopicFilter | String | topic 订阅 示例值：mytopic/a/+ |
| Qos | Integer | 服务质量等级 示例值：1 |
MQTTEndpointItem
MQTTEndpoint
被如下接口引用：DescribeMQTTInsPublicEndpoints, DescribeMQTTInsVPCEndpoints。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | String | 否 | 类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：mqtt-tcp |
| Url | String | 否 | 接入点 注意：此字段可能返回 null，表示取不到有效值。 示例值：mqtt-12345-cd.mqtt.public.tencenttdmq.com:1883 |
| VpcId | String | 否 | vpc信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：vpc-23dada |
| SubnetId | String | 否 | 子网信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：subnet-dadaf |
| Host | String | 否 | 主机 注意：此字段可能返回 null，表示取不到有效值。 示例值：mqtt-12345-cd.mqtt.public.tencenttdmq.com |
| Port | Integer | 否 | 端口 注意：此字段可能返回 null，表示取不到有效值。 示例值：1883 |
| Ip | String | 否 | 接入点ip 注意：此字段可能返回 null，表示取不到有效值。 示例值：127.0.0.1 |
MQTTInstanceItem
MQTT 实例信息
被如下接口引用：DescribeMQTTInstanceList。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例ID 示例值：mqtt-xxxx |
| InstanceName | String | 实例名称 示例值：instance-01 |
| Version | String | 实例版本 示例值：5.0 |
| InstanceType | String | 实例类型， BASIC，基础版 PRO，专业版 示例值：BASIC |
| InstanceStatus | String | 实例状态， RUNNING, 运行中 MAINTAINING，维护中 ABNORMAL，异常 OVERDUE，欠费 DESTROYED，已删除 CREATING，创建中 MODIFYING，变配中 CREATE_FAILURE，创建失败 MODIFY_FAILURE，变配失败 DELETING，删除中 示例值：RUNNING |
| TopicNumLimit | Integer | 实例主题数上限 示例值：100 |
| Remark | String | 备注信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：this is remark |
| TopicNum | Integer | 主题数量 示例值：2 |
| SkuCode | String | 商品规格 示例值：basic_1k |
| TpsLimit | Integer | 弹性TPS限流值 注意：此字段可能返回 null，表示取不到有效值。 示例值：100 |
| CreateTime | Integer | 创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1713164969433 |
| SubscriptionNumLimit | Integer | 订阅关系上限 注意：此字段可能返回 null，表示取不到有效值。 示例值：1000 |
| ClientNumLimit | Integer | 客户端连接数上线 注意：此字段可能返回 null，表示取不到有效值。 示例值：1000 |
MQTTMessageItem
消息记录
被如下接口引用：DescribeMQTTMessageList。
| 名称 | 类型 | 描述 |
|---|---|---|
| MsgId | String | 消息ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：15297521000022CF000000000EDF6894 |
| Tags | String | 消息tag 注意：此字段可能返回 null，表示取不到有效值。 示例值：tag1 |
| Keys | String | 消息key 注意：此字段可能返回 null，表示取不到有效值。 示例值：value1 |
| ProducerAddr | String | 客户端地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：127.0.0.1 |
| ProduceTime | String | 消息发送时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1713164969433 |
| DeadLetterResendTimes | Integer | 死信重发次数 注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
| DeadLetterResendSuccessTimes | Integer | 死信重发成功次数 注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
| SubTopic | String | 子topic 注意：此字段可能返回 null，表示取不到有效值。 示例值：subtopic |
| Qos | String | 消息质量等级 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
MQTTProductSkuItem
MQTT ProductSkuItem
被如下接口引用：DescribeMQTTProductSKUList。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceType | String | 类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：BASIC |
| SkuCode | String | cide 注意：此字段可能返回 null，表示取不到有效值。 示例值：basic_1000 |
| OnSale | Boolean | sale 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| TopicNumLimit | Integer | topic num限制 注意：此字段可能返回 null，表示取不到有效值。 示例值：100 |
| TpsLimit | Integer | tps 注意：此字段可能返回 null，表示取不到有效值。 示例值：1000 |
| ClientNumLimit | Integer | 客户端连接数 注意：此字段可能返回 null，表示取不到有效值。 示例值：1000 |
| SubscriptionNumLimit | Integer | 订阅数限制 注意：此字段可能返回 null，表示取不到有效值。 示例值：1000 |
| ProxySpecCore | Integer | 代理核 注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
| ProxySpecMemory | Integer | 代理内存 注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
| ProxySpecCount | Integer | 代理总数 注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
MQTTTopicItem
MQTT 主题详情
被如下接口引用：DescribeMQTTTopicList。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例 ID 示例值：mqtt-xxx |
| Topic | String | 主题名称 示例值：mytopic |
| Remark | String | 主题描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：remark1 |
MQTTUserItem
MQTT集群用户信息
被如下接口引用：DescribeMQTTUserList。
| 名称 | 类型 | 描述 |
|---|---|---|
| Username | String | 用户名 示例值：user1 |
| Password | String | 密码 示例值：pd |
| PermRead | Boolean | 是否开启消费 示例值：true |
| PermWrite | Boolean | 是否开启生产 示例值：true |
| Remark | String | 备注信息 示例值：remark1 |
| CreatedTime | Integer | 创建时间，秒为单位 示例值：1712739629775 |
| ModifiedTime | Integer | 修改时间，秒为单位 示例值：1712739629775 |
MessageItem
消息记录
被如下接口引用：DescribeMessageList。
| 名称 | 类型 | 描述 |
|---|---|---|
| MsgId | String | 消息ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：AC120002063E0DC37B1104461E710001 |
| Tags | String | 消息tag 注意：此字段可能返回 null，表示取不到有效值。 示例值：test_tag |
| Keys | String | 消息key 注意：此字段可能返回 null，表示取不到有效值。 示例值：test_key |
| ProducerAddr | String | 客户端地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：10.103.40.30:53573 |
| ProduceTime | String | 消息发送时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-01-01 00:00:01 |
| DeadLetterResendTimes | Integer | 死信重发次数 注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
| DeadLetterResendSuccessTimes | Integer | 死信重发成功次数 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
MessageTraceItem
消息轨迹
被如下接口引用：DescribeMessageTrace。
| 名称 | 类型 | 描述 |
|---|---|---|
| Stage | String | 步骤 注意：此字段可能返回 null，表示取不到有效值。 示例值：{ "MsgId": "1EAE3915000721B8D17C2C5BB31638D1", "Status": 0, } |
| Data | String | 轨迹详情 注意：此字段可能返回 null，表示取不到有效值。 示例值：produce |
MessageTrackItem
MessageTrack
被如下接口引用：DescribeMessage。
| 名称 | 类型 | 描述 |
|---|---|---|
| ConsumerGroup | String | 消费组名称 示例值：test_group |
| ConsumeStatus | String | 消费状态, CONSUMED: 已消费 CONSUMED_BUT_FILTERED: 已过滤 NOT_CONSUME: 未消费 ENTER_RETRY: 进入重试队列 ENTER_DLQ: 进入死信队列 UNKNOWN: 查询不到消费状态 示例值：CONSUMED |
| TrackType | String | track类型 示例值：CONSUMED |
| ExceptionDesc | String | 异常信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：No Exception |
PacketStatistics
MQTT客户端监控
被如下接口引用：DescribeMQTTClient。
| 名称 | 类型 | 描述 |
|---|---|---|
| MessageType | String | 类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：CONNECT |
| Qos | Integer | 服务质量 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| Count | Integer | 指标值 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
PriceTag
价格标签信息
被如下接口引用：DescribeProductSKUs。
| 名称 | 类型 | 描述 |
|---|---|---|
| Name | String | 计价名称 示例值：tps |
| Step | Integer | 步长 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
ProductSKU
商品售卖信息
被如下接口引用：DescribeProductSKUs。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceType | String | 产品类型， EXPERIMENT，体验版 BASIC，基础版 PRO，专业版 PLATINUM，铂金版 示例值：EXPERIMENT |
| SkuCode | String | 规格代码 示例值：experiment_500 |
| TpsLimit | Integer | TPS上限 注意：此字段可能返回 null，表示取不到有效值。 示例值：500 |
| ScaledTpsLimit | Integer | 弹性TPS上限 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| TopicNumLimit | Integer | 主题数量上限默认值 注意：此字段可能返回 null，表示取不到有效值。 示例值：50 |
| GroupNumLimit | Integer | 消费组数量上限 注意：此字段可能返回 null，表示取不到有效值。 示例值：500 |
| DefaultRetention | Integer | 默认消息保留时间，小时为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：72 |
| RetentionUpperLimit | Integer | 可调整消息保留时间上限，小时为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：72 |
| RetentionLowerLimit | Integer | 可调整消息保留时间下限，小时为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：24 |
| MaxMessageDelay | Integer | 延时消息最大时长，小时为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：168 |
| OnSale | Boolean | 是否可购买 示例值：true |
| PriceTags | Array of PriceTag | 计费项信息 示例值：[ { "Name": "tps", "Code": "sv_tdmq_instance_specification_test_500", "Category": "v_tdmq_instance_specification", "Step": 1 } ] |
| TopicNumUpperLimit | Integer | 主题数量上限默认最大值 注意：此字段可能返回 null，表示取不到有效值。 示例值：99 |
PublicAccessRule
公网访问安全规则
被如下接口引用：CreateMQTTInsPublicEndpoint, DescribeMQTTInsPublicEndpoints, ModifyMQTTInsPublicEndpoint。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| IpRule | String | 是 | ip网段信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：0.0.0.0/0 |
| Allow | Boolean | 是 | 允许或者拒绝 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| Remark | String | 否 | 备注信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：remark info |
RoleItem
角色信息
被如下接口引用：DescribeRoleList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| RoleName | String | 是 | 角色名称 示例值：test_role_name |
| PermRead | Boolean | 是 | 是否开启消费 示例值：true |
| PermWrite | Boolean | 是 | 是否开启生产 示例值：true |
| AccessKey | String | 否 | Access Key 示例值：ak54jmdkpmao909550a62asd |
| SecretKey | String | 否 | Secret Key 示例值：skc955042d5a678asd |
| Remark | String | 否 | 备注信息 示例值：remark info |
| CreatedTime | Integer | 否 | 创建时间，秒为单位 示例值：1683615280000 |
| ModifiedTime | Integer | 否 | 修改时间，秒为单位 示例值：1683615280000 |
| PermType | String | 否 | 权限类型，默认按集群授权（Cluster：集群级别；TopicAndGroup：主题&消费组级别） 示例值：CLUSTER |
| DetailedRolePerms | Array of DetailedRolePerm | 否 | Topic和Group维度权限配置 注意：此字段可能返回 null，表示取不到有效值。 |
SourceClusterGroupConfig
消费组配置信息
被如下接口引用：ImportSourceClusterConsumerGroups。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| GroupName | String | 是 | 消费组名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：group1 |
| Remark | String | 否 | 备注信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：remark1 |
| Imported | Boolean | 否 | 是否已导入，作为入参时无效 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| Namespace | String | 否 | 命名空间，仅4.x集群有效 注意：此字段可能返回 null，表示取不到有效值。 示例值：namespace1 |
| ImportStatus | String | 否 | 导入状态 Unknown 未知 Success 成功 Failure 失败 AlreadyExists 已存在 注意：此字段可能返回 null，表示取不到有效值。 示例值：Success |
| NamespaceV4 | String | 否 | 4.x的命名空间，出参使用 注意：此字段可能返回 null，表示取不到有效值。 示例值：namespace1 |
| GroupNameV4 | String | 否 | 4.x的消费组名，出参使用 注意：此字段可能返回 null，表示取不到有效值。 示例值：group1 |
| FullNamespaceV4 | String | 否 | 4.x的完整命名空间，出参使用 注意：此字段可能返回 null，表示取不到有效值。 示例值：namespace1 |
| ConsumeMessageOrderly | Boolean | 否 | 是否为顺序投递，5.0有效 注意：此字段可能返回 null，表示取不到有效值。 示例值：false |
SourceClusterTopicConfig
源集群主题配置
被如下接口引用：ImportSourceClusterTopics。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TopicName | String | 是 | 主题名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：topic1 |
| TopicType | String | 是 | 主题类型， 5.x版本 UNSPECIFIED 未指定 NORMAL 普通消息 FIFO 顺序消息 DELAY 延迟消息 TRANSACTION 事务消息 4.x版本 Normal 普通消息 PartitionedOrder 分区顺序消息 Transaction 事务消息 DelayScheduled 延时消息 注意：此字段可能返回 null，表示取不到有效值。 示例值：FIFO |
| QueueNum | Integer | 是 | 队列数 注意：此字段可能返回 null，表示取不到有效值。 示例值：3 |
| Remark | String | 否 | 备注信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：remark |
| Imported | Boolean | 否 | 是否已导入，作为入参时无效 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| Namespace | String | 否 | 命名空间，仅4.x集群有效 注意：此字段可能返回 null，表示取不到有效值。 示例值：namespace1 |
| ImportStatus | String | 否 | 导入状态， Unknown 未知， AlreadyExists 已存在， Success 成功， Failure 失败 注意：此字段可能返回 null，表示取不到有效值。 示例值：Unknown |
| NamespaceV4 | String | 否 | 4.x的命名空间，出参使用 注意：此字段可能返回 null，表示取不到有效值。 示例值：namespace1 |
| TopicNameV4 | String | 否 | 4.x的主题名，出参使用 注意：此字段可能返回 null，表示取不到有效值。 示例值：topic1 |
| FullNamespaceV4 | String | 否 | 4.x的完整命名空间，出参使用 注意：此字段可能返回 null，表示取不到有效值。 示例值：namespace1 |
StatisticsReport
MQTT客户端数据流量统计
被如下接口引用：DescribeMQTTClient。
| 名称 | 类型 | 描述 |
|---|---|---|
| Bytes | Integer | 字节数 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
| Items | Array of PacketStatistics | 监控指标 注意：此字段可能返回 null，表示取不到有效值。 |
SubscriptionData
主题与消费组的订阅关系数据
被如下接口引用：DescribeTopic, DescribeTopicListByGroup。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：rmq-72mo3a9o |
| Topic | String | 主题名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：test_topic |
| TopicType | String | 主题类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：FIFO |
| TopicQueueNum | Integer | 单个节点上主题队列数 注意：此字段可能返回 null，表示取不到有效值。 示例值：3 |
| ConsumerGroup | String | 消费组名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：test_group |
| IsOnline | Boolean | 是否在线 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| ConsumeType | String | 消费类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：PULL |
| SubString | String | 订阅规则 注意：此字段可能返回 null，表示取不到有效值。 示例值：test_tag |
| ExpressionType | String | 过滤类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：TAG |
| Consistency | Integer | 订阅一致性 注意：此字段可能返回 null，表示取不到有效值。 示例值：false |
| ConsumerLag | Integer | 消费堆积 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| LastUpdateTime | Integer | 最后消费进度更新时间，秒为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：1713164969433 |
| MaxRetryTimes | Integer | 最大重试次数 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| ConsumeMessageOrderly | Boolean | 是否顺序消费 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| MessageModel | String | 消费模式: BROADCASTING 广播模式; CLUSTERING 集群模式; 注意：此字段可能返回 null，表示取不到有效值。 示例值：CLUSTERING |
Tag
标签数据
被如下接口引用：CreateInstance, CreateMQTTInstance, DescribeFusionInstanceList, DescribeInstance, DescribeInstanceList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TagKey | String | 是 | 标签名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：test_key |
| TagValue | String | 是 | 标签值 注意：此字段可能返回 null，表示取不到有效值。 示例值：test_value |
TagFilter
标签过滤器
被如下接口引用：DescribeFusionInstanceList, DescribeInstanceList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TagKey | String | 是 | 标签键名称 示例值：test_key |
| TagValues | Array of String | 是 | 标签值列表 示例值：test_value |
TopicConsumeStats
主题消费进度
被如下接口引用：DescribeConsumerClient。
| 名称 | 类型 | 描述 |
|---|---|---|
| Topic | String | 主题名称 示例值：test_topic |
| TopicType | String | 主题类型 示例值：NORMAL |
| QueueNum | Integer | 单节点主题队列数量 示例值：3 |
| ConsumerLag | Integer | 消费堆积 示例值：10 |
| SubString | String | 订阅规则 示例值：test_tag |
| LastUpdateTime | Integer | 最后消费进度更新时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1736050534095 |
TopicItem
列表上的主题信息
被如下接口引用：DescribeTopicList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| InstanceId | String | 否 | 实例ID 示例值：rmq-72mo3a9o |
| Topic | String | 否 | 主题名称 示例值：test_topic |
| TopicType | String | 否 | 主题类型 NORMAL:普通消息, FIFO:顺序消息, DELAY:延时消息, TRANSACTION:事务消息 示例值：NORMAL |
| QueueNum | Integer | 否 | 队列数量 示例值：3 |
| Remark | String | 否 | 描述 示例值：test_remark |
| ClusterIdV4 | String | 否 | 4.x的集群id 注意：此字段可能返回 null，表示取不到有效值。 示例值：rocketmq-7drjznvjqzee |
| NamespaceV4 | String | 否 | 4.x的命名空间 注意：此字段可能返回 null，表示取不到有效值。 示例值：test_namespace |
| TopicV4 | String | 否 | 4.x的主题名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：test_topic_4x |
| FullNamespaceV4 | String | 否 | 4.x的完整命名空间 注意：此字段可能返回 null，表示取不到有效值。 示例值：MQ_INST_rocketmq7drjznvjqzee_test_namespace |
| MsgTTL | Integer | 否 | 消息保留时长 注意：此字段可能返回 null，表示取不到有效值。 示例值：72 |
VpcInfo
VPC信息
被如下接口引用：CreateInstance, CreateMQTTInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| VpcId | String | 是 | VPC ID 示例值：vpc-xxxx |
| SubnetId | String | 是 | 子网ID 示例值：subnet-xxxx |
