ConsumeGroupItem
消费组信息
被如下接口引用：DescribeConsumerGroupList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| InstanceId | String | 否 | 实例ID |
| ConsumerGroup | String | 否 | 消费组名称 |
| ConsumeEnable | Boolean | 否 | 是否开启消费 |
| ConsumeMessageOrderly | Boolean | 否 | 顺序投递：true 并发投递：false |
| MaxRetryTimes | Integer | 否 | 最大重试次数 |
| Remark | String | 否 | 备注 |
CustomMapEntry
map结构返回
被如下接口引用：DescribeMQTTMessage。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Key | String | 否 | key 注意：此字段可能返回 null，表示取不到有效值。 示例值：key1 |
| Value | String | 否 | value 注意：此字段可能返回 null，表示取不到有效值。 示例值：value1 |
Endpoint
接入点信息
被如下接口引用：DescribeInstance。
| 名称 | 类型 | 描述 |
|---|---|---|
| Type | String | 接入点类型，枚举值如下 VPC: VPC; PUBLIC: 公网; INTERNAL: 支撑网; 示例值：VPC |
| Status | String | 状态， OPEN 开启， CLOSE 关闭， PROCESSING 操作中， |
| PayMode | String | 付费类型，仅公网 PREPAID 包年包月 POSTPAID 按量付费 注意：此字段可能返回 null，表示取不到有效值。 |
| EndpointUrl | String | 接入点地址 注意：此字段可能返回 null，表示取不到有效值。 |
| VpcId | String | VPC ID 注意：此字段可能返回 null，表示取不到有效值。 |
| SubnetId | String | 子网ID 注意：此字段可能返回 null，表示取不到有效值。 |
| Bandwidth | Integer | 公网带宽，Mbps为单位 注意：此字段可能返回 null，表示取不到有效值。 |
| IpRules | Array of IpRule | 公网放通规则 注意：此字段可能返回 null，表示取不到有效值。 |
Filter
查询过滤器
被如下接口引用：DescribeConsumerGroupList, DescribeInstanceList, DescribeMQTTInstanceList, DescribeMQTTTopicList, DescribeMQTTUserList, DescribeRoleList, DescribeTopic, DescribeTopicList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 是 | 过滤条件名 示例值：key |
| Values | Array of String | 是 | 过滤条件的值 |
InstanceItem
实例列表页中的实例信息
被如下接口引用：DescribeInstanceList。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例ID 示例值：rmq-xxxx |
| InstanceName | String | 实例名称 示例值：test |
| Version | String | 实例版本 示例值：5.0 |
| InstanceType | String | 实例类型， EXPERIMENT，体验版 BASIC，基础版 PRO，专业版 PLATINUM，铂金版 |
| InstanceStatus | String | 实例状态， RUNNING, 运行中 MAINTAINING，维护中 ABNORMAL，异常 OVERDUE，欠费 DESTROYED，已删除 CREATING，创建中 MODIFYING，变配中 CREATE_FAILURE，创建失败 MODIFY_FAILURE，变配失败 DELETING，删除中 |
| TopicNumLimit | Integer | 实例主题数上限 示例值：100 |
| GroupNumLimit | Integer | 实例消费组数量上限 示例值：100 |
| PayMode | String | 计费模式， POSTPAID，按量计费 PREPAID，包年包月 示例值：0 |
| ExpiryTime | Integer | 到期时间，秒为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：100000 |
| Remark | String | 备注信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：test |
| TopicNum | Integer | 主题数量 |
| GroupNum | Integer | 消费组数量 |
| TagList | Array of Tag | 标签列表 注意：此字段可能返回 null，表示取不到有效值。 |
| SkuCode | String | 商品规格 示例值：basic_1k |
| TpsLimit | Integer | TPS限流值 注意：此字段可能返回 null，表示取不到有效值。 |
| ScaledTpsLimit | Integer | 弹性TPS限流值 注意：此字段可能返回 null，表示取不到有效值。 |
| MessageRetention | Integer | 消息保留时间，小时为单位 注意：此字段可能返回 null，表示取不到有效值。 |
| MaxMessageDelay | Integer | 延迟消息最大时长，小时为单位 注意：此字段可能返回 null，表示取不到有效值。 |
IpRule
IP规则
被如下接口引用：CreateInstance, CreateMQTTInstance, DescribeInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| 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 示例值：rmq-xxxx |
| InstanceName | String | 实例名称 示例值：test |
| 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 |
| Remark | String | 备注信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：test |
| 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，表示取不到有效值。 示例值：test |
| 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 |
PacketStatistics
MQTT客户端监控
被如下接口引用：DescribeMQTTClient。
| 名称 | 类型 | 描述 |
|---|---|---|
| MessageType | String | 类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：CONNECT |
| Qos | Integer | 服务质量 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| Count | Integer | 指标值 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
PublicAccessRule
公网访问安全规则
被如下接口引用：CreateMQTTInsPublicEndpoint, DescribeMQTTInsPublicEndpoints, ModifyMQTTInsPublicEndpoint。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| IpRule | String | 是 | ip网段信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：0.0.0.0/0 |
| Allow | Boolean | 是 | 允许或者拒绝 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| Remark | String | 否 | 备注信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：test |
RoleItem
角色信息
被如下接口引用：DescribeRoleList。
| 名称 | 类型 | 描述 |
|---|---|---|
| RoleName | String | 角色名称 示例值：test |
| AccessKey | String | Access Key |
| SecretKey | String | Secret Key |
| PermRead | Boolean | 是否开启消费 |
| PermWrite | Boolean | 是否开启生产 |
| Remark | String | 备注信息 |
| CreatedTime | Integer | 创建时间，秒为单位 |
| ModifiedTime | Integer | 修改时间，秒为单位 |
SourceClusterGroupConfig
消费组配置信息
被如下接口引用：ImportSourceClusterConsumerGroups。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| GroupName | String | 是 | 消费组名称 注意：此字段可能返回 null，表示取不到有效值。 |
| Remark | String | 否 | 备注信息 注意：此字段可能返回 null，表示取不到有效值。 |
| Imported | Boolean | 否 | 是否已导入，作为入参时无效 注意：此字段可能返回 null，表示取不到有效值。 |
| Namespace | String | 否 | 命名空间，仅4.x集群有效 注意：此字段可能返回 null，表示取不到有效值。 |
| ImportStatus | String | 否 | 导入状态 Unknown 未知 Success 成功 Failure 失败 AlreadyExists 已存在 注意：此字段可能返回 null，表示取不到有效值。 |
SourceClusterTopicConfig
源集群主题配置
被如下接口引用：ImportSourceClusterTopics。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TopicName | String | 是 | 主题名称 注意：此字段可能返回 null，表示取不到有效值。 |
| TopicType | String | 是 | 主题类型， 5.x版本 UNSPECIFIED 未指定 NORMAL 普通消息 FIFO 顺序消息 DELAY 延迟消息 TRANSACTION 事务消息 4.x版本 Normal 普通消息 PartitionedOrder 分区顺序消息 Transaction 事务消息 DelayScheduled 延时消息 注意：此字段可能返回 null，表示取不到有效值。 |
| QueueNum | Integer | 是 | 队列数 注意：此字段可能返回 null，表示取不到有效值。 |
| Remark | String | 否 | 备注信息 注意：此字段可能返回 null，表示取不到有效值。 |
| Imported | Boolean | 否 | 是否已导入，作为入参时无效 注意：此字段可能返回 null，表示取不到有效值。 |
| Namespace | String | 否 | 命名空间，仅4.x集群有效 注意：此字段可能返回 null，表示取不到有效值。 |
| ImportStatus | String | 否 | 导入状态， Unknown 未知， AlreadyExists 已存在， Success 成功， Failure 失败 注意：此字段可能返回 null，表示取不到有效值。 |
StatisticsReport
MQTT客户端数据流量统计
被如下接口引用：DescribeMQTTClient。
| 名称 | 类型 | 描述 |
|---|---|---|
| Bytes | Integer | 字节数 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
| Items | Array of PacketStatistics | 监控指标 注意：此字段可能返回 null，表示取不到有效值。 |
SubscriptionData
主题与消费组的订阅关系数据
被如下接口引用：DescribeTopic。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：rmq-xxx |
| Topic | String | 主题名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：test |
| TopicType | String | 主题类型 注意：此字段可能返回 null，表示取不到有效值。 |
| TopicQueueNum | Integer | 单个节点上主题队列数 注意：此字段可能返回 null，表示取不到有效值。 |
| ConsumerGroup | String | 消费组名称 注意：此字段可能返回 null，表示取不到有效值。 |
| IsOnline | Boolean | 是否在线 注意：此字段可能返回 null，表示取不到有效值。 |
| ConsumeType | String | 消费类型 注意：此字段可能返回 null，表示取不到有效值。 |
| SubString | String | 订阅规则 注意：此字段可能返回 null，表示取不到有效值。 |
| ExpressionType | String | 过滤类型 注意：此字段可能返回 null，表示取不到有效值。 |
| Consistency | Integer | 订阅一致性 注意：此字段可能返回 null，表示取不到有效值。 |
| ConsumerLag | Integer | 消费堆积 注意：此字段可能返回 null，表示取不到有效值。 |
| LastUpdateTime | Integer | 最后消费进度更新时间，秒为单位 注意：此字段可能返回 null，表示取不到有效值。 |
| MaxRetryTimes | Integer | 最大重试次数 注意：此字段可能返回 null，表示取不到有效值。 |
| ConsumeMessageOrderly | Boolean | 是否顺序消费 注意：此字段可能返回 null，表示取不到有效值。 |
| MessageModel | String | 消费模式: BROADCASTING 广播模式; CLUSTERING 集群模式; 注意：此字段可能返回 null，表示取不到有效值。 示例值：CLUSTERING |
Tag
标签数据
被如下接口引用：CreateInstance, CreateMQTTInstance, DescribeInstance, DescribeInstanceList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TagKey | String | 是 | 标签名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：123 |
| TagValue | String | 是 | 标签值 注意：此字段可能返回 null，表示取不到有效值。 示例值：abc |
TagFilter
标签过滤器
被如下接口引用：DescribeInstanceList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TagKey | String | 是 | 标签键名称 示例值：test |
| TagValues | Array of String | 是 | 标签值列表 |
TopicItem
列表上的主题信息
被如下接口引用：DescribeTopicList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| InstanceId | String | 否 | 实例ID 示例值：rmq-xxxx |
| Topic | String | 否 | 主题名称 示例值：test |
| TopicType | String | 否 | 主题类型 |
| QueueNum | Integer | 否 | 队列数量 示例值：3 |
| Remark | String | 否 | 描述 注意：此字段可能返回 null，表示取不到有效值。 |
| ClusterIdV4 | String | 否 | 4.x的集群id 注意：此字段可能返回 null，表示取不到有效值。 |
| NamespaceV4 | String | 否 | 4.x的命名空间 注意：此字段可能返回 null，表示取不到有效值。 |
| TopicV4 | String | 否 | 4.x的主题名称 注意：此字段可能返回 null，表示取不到有效值。 |
| FullNamespaceV4 | String | 否 | 4.x的完整命名空间 注意：此字段可能返回 null，表示取不到有效值。 |
| MsgTTL | Integer | 否 | 消息保留时长 注意：此字段可能返回 null，表示取不到有效值。 示例值：72 |
VpcInfo
VPC信息
被如下接口引用：CreateInstance, CreateMQTTInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| VpcId | String | 是 | VPC ID 示例值：vpc-xxxx |
| SubnetId | String | 是 | 子网ID 示例值：subnet-xxxx |