AMQPClusterConfig
AMQP集群配置
被如下接口引用：DescribeAMQPClusters。
| 名称 | 类型 | 描述 |
|---|---|---|
| MaxTpsPerVHost | Integer | 单Vhost TPS上限 示例值：8000 |
| MaxConnNumPerVHost | Integer | 单Vhost客户端连接数上限 示例值：8000 |
| MaxVHostNum | Integer | 最大Vhost数量 示例值：10 |
| MaxExchangeNum | Integer | 最大exchange数量 示例值：100 |
| MaxQueueNum | Integer | 最大Queue数量 示例值：100 |
| MaxRetentionTime | Integer | 消息最大保留时间，以毫秒为单位 示例值：100000 |
| UsedVHostNum | Integer | 已使用Vhost数量 示例值：3 |
| UsedExchangeNum | Integer | 已使用exchange数量 示例值：3 |
| UsedQueueNum | Integer | 已使用queue数量 示例值：8 |
AMQPClusterDetail
租户AMQP集群详细信息
被如下接口引用：DescribeAMQPClusters。
| 名称 | 类型 | 描述 |
|---|---|---|
| Info | AMQPClusterInfo | 集群基本信息 |
| Config | AMQPClusterConfig | 集群配置信息 |
| Tags | Array of Tag | 标签 注意：此字段可能返回 null，表示取不到有效值。 |
| Status | Integer | 集群状态，0:创建中，1:正常，2:销毁中，3:已删除，4: 隔离中，5:创建失败，6: 删除失败 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
AMQPClusterInfo
AMQP集群基本信息
被如下接口引用：DescribeAMQPClusters。
| 名称 | 类型 | 描述 |
|---|---|---|
| ClusterId | String | 集群ID 示例值：amqp-xxxxx |
| ClusterName | String | 集群名称 示例值：test |
| Region | String | 地域信息 示例值：华南地区 |
| CreateTime | Integer | 创建时间，毫秒为单位 示例值：100000000 |
| Remark | String | 集群说明信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：备注 |
| PublicEndPoint | String | 公网接入地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：xxxx |
| VpcEndPoint | String | VPC接入地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：xxxxx |
BindCluster
用户专享集群信息
被如下接口引用：DescribeBindClusters。
| 名称 | 类型 | 描述 |
|---|---|---|
| ClusterName | String | 物理集群的名称 示例值：devClusterName |
ClientSubscriptionInfo
客户端订阅详情，可用于辅助判断哪些客户端订阅关系不一致
被如下接口引用：DescribeRocketMQSubscriptions。
| 名称 | 类型 | 描述 |
|---|---|---|
| ClientId | String | 客户端ID 示例值：rocketmq-2p9vx3ax9jxg |
| ClientAddr | String | 客户端IP 注意：此字段可能返回 null，表示取不到有效值。 示例值：1.1.1.12 |
| Topic | String | 订阅主题 注意：此字段可能返回 null，表示取不到有效值。 示例值：test_topic |
| SubString | String | 订阅表达式 注意：此字段可能返回 null，表示取不到有效值。 示例值：test_tag |
| ExpressionType | String | 订阅方式 注意：此字段可能返回 null，表示取不到有效值。 示例值：TAG |
Cluster
集群信息集合
被如下接口引用：DescribeClusterDetail, DescribeClusters。
| 名称 | 类型 | 描述 |
|---|---|---|
| ClusterId | String | 集群Id。 示例值：1000 |
| ClusterName | String | 集群名称。 示例值：pulsar-47emajijmazk |
| Remark | String | 说明信息。 示例值：devInfo |
| EndPointNum | Integer | 接入点数量 示例值：0 |
| CreateTime | String | 创建时间 示例值：2021-04-21 19:00:00 |
| Healthy | Integer | 集群是否健康，1表示健康，0表示异常 示例值：1 |
| HealthyInfo | String | 集群健康信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：healthy |
| Status | Integer | 集群状态，0:创建中，1:正常，2:销毁中，3:已删除，4: 隔离中，5:创建失败，6: 删除失败 示例值：1 |
| MaxNamespaceNum | Integer | 最大命名空间数量 示例值：100 |
| MaxTopicNum | Integer | 最大Topic数量 示例值：8000 |
| MaxQps | Integer | 最大QPS 示例值：1000 |
| MessageRetentionTime | Integer | 最大消息保留时间，秒为单位 示例值：100000000 |
| MaxStorageCapacity | Integer | 最大存储容量 示例值：1024 |
| Version | String | 集群版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：2.5.1 |
| PublicEndPoint | String | 公网访问接入点 注意：此字段可能返回 null，表示取不到有效值。 示例值：http://pulsar-45epqe3j7jvz.sap-8iutas0k.tdmq.ap-gz.qcloud.tencenttdmq.com:8080 |
| VpcEndPoint | String | VPC访问接入点 注意：此字段可能返回 null，表示取不到有效值。 示例值：http://pulsar-45epqe3j7jvz.sap-8iutas0k.tdmq.ap-gz.qcloud.tencenttdmq.com:8080 |
| NamespaceNum | Integer | 命名空间数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
| UsedStorageBudget | Integer | 已使用存储限制，MB为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| MaxPublishRateInMessages | Integer | 最大生产消息速率，以条数为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| MaxDispatchRateInMessages | Integer | 最大推送消息速率，以条数为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| MaxPublishRateInBytes | Integer | 最大生产消息速率，以字节为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| MaxDispatchRateInBytes | Integer | 最大推送消息速率，以字节为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| TopicNum | Integer | 已创建主题数 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| MaxMessageDelayInSeconds | Integer | 最长消息延时，以秒为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| PublicAccessEnabled | Boolean | 是否开启公网访问，不填时默认开启 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| Tags | Array of Tag | 标签 注意：此字段可能返回 null，表示取不到有效值。 |
| PayMode | Integer | 计费模式： 0: 按量计费 1: 包年包月 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| ProjectId | Integer | 项目ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：251198839 |
| ProjectName | String | 项目名字 注意：此字段可能返回 null，表示取不到有效值。 示例值：product01 |
CmqDeadLetterPolicy
cmq DeadLetterPolicy
被如下接口引用：DescribeCmqQueueDetail, DescribeCmqQueues。
| 名称 | 类型 | 描述 |
|---|---|---|
| DeadLetterQueue | String | 死信队列。 注意：此字段可能返回 null，表示取不到有效值。 示例值：test-queue |
| Policy | Integer | 死信队列策略。0:最大接收次数;1:最大未消费时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| MaxTimeToLive | Integer | 最大未消费过期时间。Policy为1时必选。范围300-43200，单位秒，需要小于消息最大保留时间MsgRetentionSeconds。 注意：此字段可能返回 null，表示取不到有效值。 示例值：300 |
| MaxReceiveCount | Integer | 最大接收次数。Policy为0时必选，范围在1到1000。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
CmqDeadLetterSource
Cmq DeadLetterSource
被如下接口引用：DescribeCmqDeadLetterSourceQueues, DescribeCmqQueueDetail, DescribeCmqQueues。
| 名称 | 类型 | 描述 |
|---|---|---|
| QueueId | String | 消息队列ID。 注意：此字段可能返回 null，表示取不到有效值。 示例值：cmq-112233 |
| QueueName | String | 消息队列名字。 注意：此字段可能返回 null，表示取不到有效值。 示例值：test1 |
CmqQueue
cmq 批量queue属性信息
被如下接口引用：DescribeCmqQueueDetail, DescribeCmqQueues。
| 名称 | 类型 | 描述 |
|---|---|---|
| QueueId | String | 消息队列ID。 示例值：cmqq-bzgqn8 |
| QueueName | String | 消息队列名字。 示例值：test-queue |
| Qps | Integer | 每秒钟生产消息条数的限制，消费消息的大小是该值的1.1倍。 注意：此字段可能返回 null，表示取不到有效值。 示例值：5000 |
| Bps | Integer | 带宽限制。 注意：此字段可能返回 null，表示取不到有效值。 示例值：52428800 |
| MaxDelaySeconds | Integer | 飞行消息最大保留时间，需要小于消息保留周期。 注意：此字段可能返回 null，表示取不到有效值。 示例值：3600 |
| MaxMsgHeapNum | Integer | 最大堆积消息数。取值范围在公测期间为 1,000,000 - 10,000,000，正式上线后范围可达到 1000,000-1000,000,000。默认取值在公测期间为 10,000,000，正式上线后为 100,000,000。 示例值：1000000 |
| PollingWaitSeconds | Integer | 消息接收长轮询等待时间。取值范围0 - 30秒，默认值0。 注意：此字段可能返回 null，表示取不到有效值。 示例值：3 |
| MsgRetentionSeconds | Integer | 消息保留周期。取值范围60-1296000秒（1min-15天），默认值345600秒（4 天）。 注意：此字段可能返回 null，表示取不到有效值。 示例值：7200 |
| VisibilityTimeout | Integer | 消息可见性超时。取值范围1 - 43200秒（即12小时内），默认值30。 注意：此字段可能返回 null，表示取不到有效值。 示例值：30 |
| MaxMsgSize | Integer | 消息最大长度。取值范围1024 - 1048576 Byte（即1K - 1024K），默认值65536。 注意：此字段可能返回 null，表示取不到有效值。 示例值：1048576 |
| RewindSeconds | Integer | 回溯队列的消息回溯时间最大值，取值范围0 - 43200秒，0表示不开启消息回溯。 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| CreateTime | Integer | 队列的创建时间。返回 Unix 时间戳，精确到毫秒。 注意：此字段可能返回 null，表示取不到有效值。 示例值：1726730748000 |
| LastModifyTime | Integer | 最后一次修改队列属性的时间。返回 Unix 时间戳，精确到毫秒。 注意：此字段可能返回 null，表示取不到有效值。 示例值：1729740386000 |
| ActiveMsgNum | Integer | 在队列中处于 Active 状态（不处于被消费状态）的消息总数，为近似值。 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| InactiveMsgNum | Integer | 在队列中处于 Inactive 状态（正处于被消费状态）的消息总数，为近似值。 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| DelayMsgNum | Integer | 延迟消息数。 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| RewindMsgNum | Integer | 已调用 DelMsg 接口删除，但还在回溯保留时间内的消息数量。 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| MinMsgTime | Integer | 消息最小未消费时间，单位为秒。 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| Transaction | Boolean | 事务消息队列。true表示是事务消息，false表示不是事务消息。 注意：此字段可能返回 null，表示取不到有效值。 示例值：false |
| DeadLetterSource | Array of CmqDeadLetterSource | 死信队列。 注意：此字段可能返回 null，表示取不到有效值。 示例值：[{"QueueId":null,"QueueName":"test0829"}] |
| DeadLetterPolicy | CmqDeadLetterPolicy | 死信队列策略。 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"DeadLetterQueue":"queue1","Policy":0,"MaxTimeToLive":0,"MaxReceiveCount":22} |
| TransactionPolicy | CmqTransactionPolicy | 事务消息策略。 注意：此字段可能返回 null，表示取不到有效值。 示例值：null |
| CreateUin | Integer | 创建者Uin。 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| Tags | Array of Tag | 关联的标签。 注意：此字段可能返回 null，表示取不到有效值。 示例值：[{"TagKey":"aa","TagValue":"bb"}] |
| Trace | Boolean | 消息轨迹。true表示开启，false表示不开启。 注意：此字段可能返回 null，表示取不到有效值。 示例值：false |
| TenantId | String | 租户id 注意：此字段可能返回 null，表示取不到有效值。 示例值：cmq-131794 |
| NamespaceName | String | 命名空间名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：CMQ_QUEUE-test-queue |
| Status | Integer | 集群状态，0:创建中，1:正常，2:销毁中，3:已删除，4: 隔离中，5:创建失败，6: 删除失败 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| MaxUnackedMsgNum | Integer | 最大未确认消息数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：100000 |
| MaxMsgBacklogSize | Integer | 最大消息堆积大小（字节） 注意：此字段可能返回 null，表示取不到有效值。 示例值：104857600 |
| RetentionSizeInMB | Integer | 队列可回溯存储空间，取值范围1024MB - 10240MB，0表示不开启 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
CmqSubscription
cmq订阅返回参数
被如下接口引用：DescribeCmqSubscriptionDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| SubscriptionName | String | 订阅名字，在单个地域同一帐号的同一主题下唯一。订阅名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。 注意：此字段可能返回 null，表示取不到有效值。 示例值：sub |
| SubscriptionId | String | 订阅 ID。订阅 ID 在拉取监控数据时会用到。 注意：此字段可能返回 null，表示取不到有效值。 示例值：subsc-w4nojx4a |
| TopicOwner | Integer | 订阅拥有者的 APPID。 注意：此字段可能返回 null，表示取不到有效值。 示例值：1234567 |
| MsgCount | Integer | 该订阅待投递的消息数。 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| LastModifyTime | Integer | 最后一次修改订阅属性的时间。返回 Unix 时间戳，精确到毫秒。 注意：此字段可能返回 null，表示取不到有效值。 示例值：1692691279000 |
| CreateTime | Integer | 订阅的创建时间。返回 Unix 时间戳，精确到毫秒。 注意：此字段可能返回 null，表示取不到有效值。 示例值：1692691279000 |
| BindingKey | Array of String | 表示订阅接收消息的过滤策略。 注意：此字段可能返回 null，表示取不到有效值。 示例值：["news"] |
| Endpoint | String | 接收通知的 endpoint，根据协议 protocol 区分：对于 HTTP，endpoint 必须以http://开头，host 可以是域名或 IP；对于 queue，则填 queueName。 注意：此字段可能返回 null，表示取不到有效值。 示例值：queue |
| FilterTags | Array of String | 描述用户创建订阅时选择的过滤策略： filterType = 1表示用户使用 filterTag 标签过滤 filterType = 2表示用户使用 bindingKey 过滤。 注意：此字段可能返回 null，表示取不到有效值。 示例值：["tag1"] |
| Protocol | String | 订阅的协议，目前支持两种协议：HTTP、queue。使用 HTTP 协议，用户需自己搭建接受消息的 Web Server。使用 queue，消息会自动推送到 CMQ queue，用户可以并发地拉取消息。 注意：此字段可能返回 null，表示取不到有效值。 示例值：queue |
| NotifyStrategy | String | 向 endpoint 推送消息出现错误时，CMQ 推送服务器的重试策略。取值有： （1）BACKOFF_RETRY，退避重试。每隔一定时间重试一次，重试够一定次数后，就把该消息丢弃，继续推送下一条消息； （2）EXPONENTIAL_DECAY_RETRY，指数衰退重试。每次重试的间隔是指数递增的，例如开始 1s，后面是 2s，4s，8s...由于 Topic 消息的周期是一天，所以最多重试一天就把消息丢弃。默认值是 EXPONENTIAL_DECAY_RETRY。 注意：此字段可能返回 null，表示取不到有效值。 示例值：EXPONENTIAL_DECAY_RETRY |
| NotifyContentFormat | String | 推送内容的格式。取值：（1）JSON；（2）SIMPLIFIED，即 raw 格式。如果 protocol 是 queue，则取值必须为 SIMPLIFIED。如果 protocol 是 HTTP，两个值均可以，默认值是 JSON。 注意：此字段可能返回 null，表示取不到有效值。 示例值：SIMPLIFIED |
| TopicName | String | 订阅所属的主题名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：testTopic |
CmqTopic
cmq topic返回信息展示字段
被如下接口引用：DescribeCmqTopicDetail, DescribeCmqTopics。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TopicId | String | 否 | 主题的 ID。 注意：此字段可能返回 null，表示取不到有效值。 示例值：cmqt-w4nb4z |
| TopicName | String | 否 | 主题名称。 注意：此字段可能返回 null，表示取不到有效值。 示例值：testTopic |
| MsgRetentionSeconds | Integer | 否 | 消息在主题中最长存活时间，从发送到该主题开始经过此参数指定的时间后，不论消息是否被成功推送给用户都将被删除，单位为秒。固定为一天（86400秒），该属性不能修改。 注意：此字段可能返回 null，表示取不到有效值。 示例值：86400 |
| MaxMsgSize | Integer | 否 | 消息最大长度。取值范围1024 - 1048576Byte（即1 - 1024K），默认值为1048576。 注意：此字段可能返回 null，表示取不到有效值。 示例值：1048576 |
| Qps | Integer | 否 | 每秒钟发布消息的条数。 注意：此字段可能返回 null，表示取不到有效值。 示例值：5000 |
| FilterType | Integer | 否 | 描述用户创建订阅时选择的过滤策略： FilterType = 1表示用户使用 FilterTag 标签过滤; FilterType = 2表示用户使用 BindingKey 过滤。 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| CreateTime | Integer | 否 | 主题的创建时间。返回 Unix 时间戳，精确到毫秒。 注意：此字段可能返回 null，表示取不到有效值。 示例值：1692691278000 |
| LastModifyTime | Integer | 否 | 最后一次修改主题属性的时间。返回 Unix 时间戳，精确到毫秒。 注意：此字段可能返回 null，表示取不到有效值。 示例值：1692691278000 |
| MsgCount | Integer | 否 | 当前该主题中消息数目（消息堆积数）。 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| CreateUin | Integer | 否 | 创建者 Uin，CAM 鉴权 resource 由该字段组合而成。 注意：此字段可能返回 null，表示取不到有效值。 示例值：1234567 |
| Tags | Array of Tag | 否 | 关联的标签。 注意：此字段可能返回 null，表示取不到有效值。 示例值：[{"TagKey":"aa","TagValue":"bb"}] |
| Trace | Boolean | 否 | 消息轨迹。true表示开启，false表示不开启。 注意：此字段可能返回 null，表示取不到有效值。 示例值：false |
| TenantId | String | 否 | 租户id 注意：此字段可能返回 null，表示取不到有效值。 示例值：cmq-13179 |
| NamespaceName | String | 否 | 命名空间名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：CMQ_TOPIC-testTopic |
| Status | Integer | 否 | 集群状态，0:创建中，1:正常，2:销毁中，3:已删除，4: 隔离中，5:创建失败，6: 删除失败 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| BrokerType | Integer | 否 | 0表示pulsar，1表示rocketmq 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| SubscriptionCount | Integer | 否 | 订阅数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
CmqTransactionPolicy
cmq TransactionPolicy
被如下接口引用：DescribeCmqQueueDetail, DescribeCmqQueues。
| 名称 | 类型 | 描述 |
|---|---|---|
| FirstQueryInterval | Integer | 第一次回查时间。 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| MaxQueryCount | Integer | 最大查询次数。 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
Consumer
消费者
被如下接口引用：DescribeSubscriptions。
| 名称 | 类型 | 描述 |
|---|---|---|
| ConnectedSince | String | 消费者开始连接的时间。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-04-11T23:03:47.328+08:00 |
| ConsumerAddr | String | 消费者地址。 注意：此字段可能返回 null，表示取不到有效值。 示例值：30.11.19.46:40940 |
| ConsumerName | String | 消费者名称。 注意：此字段可能返回 null，表示取不到有效值。 示例值：devName1 |
| ClientVersion | String | 消费者版本。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2.7.1 |
| Partition | Integer | 消费者连接的主题分区号 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
ConsumerLog
消费日志
被如下接口引用：DescribeMsgTrace。
| 名称 | 类型 | 描述 |
|---|---|---|
| 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 | Integer | 消费耗时（毫秒）。 示例值：12 |
| Status | String | 消费状态。 示例值：0 |
ConsumerLogs
消费信息
被如下接口引用：DescribeMsgTrace。
| 名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 记录数。 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| ConsumerLogSets | Array of ConsumerLog | 消费日志。 注意：此字段可能返回 null，表示取不到有效值。 |
ConsumerStats
消费详情
被如下接口引用：DescribeRocketMQConsumeStats。
| 名称 | 类型 | 描述 |
|---|---|---|
| TopicName | String | 主题名 注意：此字段可能返回 null，表示取不到有效值。 示例值：test_topic |
| BrokerName | String | 所属Broker 注意：此字段可能返回 null，表示取不到有效值。 示例值：rocketmq-7j8m97bqpx5d-0 |
| QueueId | Integer | 队列编号 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
| ConsumerClientId | String | 消费者ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：9.43.174.90@18834#7187709773375173 |
| ConsumerOffset | Integer | 消费位点 注意：此字段可能返回 null，表示取不到有效值。 示例值：30 |
| BrokerOffset | Integer | 服务端位点 注意：此字段可能返回 null，表示取不到有效值。 示例值：100 |
| DiffTotal | Integer | 消息堆积条数 注意：此字段可能返回 null，表示取不到有效值。 示例值：70 |
| LastTimestamp | Integer | 最近消费时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1727580008838 |
ConsumersSchedule
消费进度详情
被如下接口引用：DescribeSubscriptions。
| 名称 | 类型 | 描述 |
|---|---|---|
| Partitions | Integer | 当前分区id。 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| NumberOfEntries | Integer | 消息数量。 注意：此字段可能返回 null，表示取不到有效值。 示例值：1000 |
| MsgBacklog | Integer | 消息积压数量。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
| MsgRateOut | String | 消费者每秒分发消息的数量之和。 示例值：0.0 |
| MsgThroughputOut | String | 消费者每秒消息的byte。 示例值：0.0 |
| MsgRateExpired | String | 超时丢弃比例。 注意：此字段可能返回 null，表示取不到有效值。 示例值：0.0 |
Environment
命名空间信息
被如下接口引用：DescribeEnvironments。
| 名称 | 类型 | 描述 |
|---|---|---|
| EnvironmentId | String | 命名空间名称 示例值：devNs |
| Remark | String | 说明 示例值：devRemark |
| MsgTTL | Integer | 未消费消息过期时间，单位：秒，最大1296000（15天） 示例值：2 |
| CreateTime | Timestamp | 创建时间 示例值：2020-02-17 00:00:00 |
| UpdateTime | Timestamp | 最近修改时间 示例值：2020-02-17 00:00:00 |
| NamespaceId | String | 命名空间ID 示例值：devName1 |
| NamespaceName | String | 命名空间名称 示例值：devName1 |
| TopicNum | Integer | Topic数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
| RetentionPolicy | RetentionPolicy | 消息保留策略 注意：此字段可能返回 null，表示取不到有效值。 |
| AutoSubscriptionCreation | Boolean | 是否自动创建订阅 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
EnvironmentRole
环境角色集合
被如下接口引用：DescribeEnvironmentRoles, DescribeRocketMQEnvironmentRoles。
| 名称 | 类型 | 描述 |
|---|---|---|
| EnvironmentId | String | 环境（命名空间）。 示例值：test_namespace |
| RoleName | String | 角色名称。 示例值：test_role_name |
| Permissions | Array of String | 授权项，最多只能包含produce、consume两项的非空字符串数组。 示例值：["produce"] |
| RoleDescribe | String | 角色描述。 示例值：测试角色 |
| CreateTime | Timestamp | 创建时间。 示例值：2023-07-18 17:06:57 |
| UpdateTime | Timestamp | 更新时间。 示例值：2023-07-18 17:06:57 |
EnvironmentRoleSet
批量绑定名字空间和角色权限关系
被如下接口引用：CreateRole, ModifyRole。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| EnvironmentId | String | 是 | 需要绑定的命名空间Id，不重复且存在资源 注意：此字段可能返回 null，表示取不到有效值。 示例值：devNs |
| Permissions | Array of String | 是 | 名字空间需要绑定的权限，枚举为 "consume" "produce" 组合，但是不为空 注意：此字段可能返回 null，表示取不到有效值。 示例值：["produce"] |
ExchangeQuota
exchange使用配额信息
被如下接口引用：DescribeRabbitMQVipInstance。
| 名称 | 类型 | 描述 |
|---|---|---|
| MaxExchange | Integer | 可创建最大exchange数 示例值：10 |
| UsedExchange | Integer | 已创建exchange数 注意：此字段可能返回 null，表示取不到有效值。 示例值：5 |
Filter
过滤参数
被如下接口引用：DescribeAMQPClusters, DescribeClusters, DescribeCmqQueues, DescribeCmqTopics, DescribeEnvironmentRoles, DescribeEnvironments, DescribePublishers, DescribePulsarProInstances, DescribeRabbitMQNodeList, DescribeRabbitMQVipInstances, DescribeRabbitMQVirtualHost, DescribeRocketMQClusters, DescribeRocketMQEnvironmentRoles, DescribeRocketMQMigratingTopicList, DescribeRocketMQRoles, DescribeRocketMQSmoothMigrationTaskList, DescribeRocketMQSourceClusterGroupList, DescribeRocketMQSourceClusterTopicList, DescribeRocketMQVipInstances, DescribeRoles, DescribeTopics。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 否 | 过滤参数的名字 示例值：paramName |
| Values | Array of String | 否 | 数值 示例值：["a"] |
FilterSubscription
过滤订阅列表
被如下接口引用：DescribeSubscriptions。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ConsumerHasCount | Boolean | 否 | 是否仅展示包含真实消费者的订阅。 示例值：false |
| ConsumerHasBacklog | Boolean | 否 | 是否仅展示消息堆积的订阅。 示例值：false |
| ConsumerHasExpired | Boolean | 否 | 是否仅展示存在消息超期丢弃的订阅。 示例值：false |
| SubscriptionNames | Array of String | 否 | 按照订阅名过滤，精确查询。 示例值：false |
InstanceNodeDistribution
实例节点分布信息
被如下接口引用：DescribePulsarProInstanceDetail, DescribeRocketMQVipInstanceDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| ZoneName | String | 可用区 示例值：ap-guangzhou-1 |
| ZoneId | String | 可用区id 示例值：100001 |
| NodeCount | Integer | 节点数 示例值：2 |
| NodePermWipeFlag | Boolean | 有调度任务且没有切回的可用区，此标识为true 示例值：false |
InternalTenant
面向运营端的虚拟集群信息
被如下接口引用：DescribeAllTenants。
| 名称 | 类型 | 描述 |
|---|---|---|
| TenantId | String | 虚拟集群ID 示例值：pulsar-mw4qmgaq298g |
| TenantName | String | 虚拟集群名称 示例值：devName1 |
| CustomerUin | String | 客户UIN 示例值：1000000 |
| CustomerAppId | String | 客户的APPID 示例值：123456546 |
| ClusterName | String | 物理集群名称 示例值：devName2 |
| Type | String | 集群协议类型，支持的值为TDMQ，ROCKETMQ，AMQP，CMQ 示例值：TDMQ |
| MaxNamespaces | Integer | 命名空间配额 示例值：100 |
| UsedNamespaces | Integer | 已使用命名空间配额 示例值：0 |
| MaxTopics | Integer | Topic配额 示例值：100 |
| UsedTopics | Integer | 已使用Topic配额 示例值：0 |
| MaxPartitions | Integer | Topic分区数配额 示例值：100 |
| UsedPartitions | Integer | 已使用Topic分区数配额 示例值：0 |
| MaxMsgBacklogSize | Integer | 存储配额, byte为单位 示例值：100 |
| MaxPublishTps | Integer | 命名空间最大生产TPS 示例值：100 |
| MaxRetention | Integer | 消息最大保留时间，秒为单位 示例值：100 |
| CreateTime | Integer | 创建时间，毫秒为单位 示例值：0 |
| UpdateTime | Integer | 修改时间，毫秒为单位 示例值：0 |
| MaxDispatchTps | Integer | 命名空间最大消费TPS 示例值：1000 |
| MaxDispatchRateInBytes | Integer | 命名空间最大消费带宽，byte为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| MaxPublishRateInBytes | Integer | 命名空间最大生产带宽，byte为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| MaxRetentionSizeInMB | Integer | 消息最大保留空间，MB为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| PublicAccessEnabled | Boolean | public Access Enabled 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
MigrateTopic
迁移topic列表数据
被如下接口引用：DescribeRocketMQMigratingTopicList。
| 名称 | 类型 | 描述 |
|---|---|---|
| Namespace | String | 命名空间 注意：此字段可能返回 null，表示取不到有效值。 |
| TopicName | String | topic名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：AAA |
| MigrationStatus | String | 迁移状态 S_RW_D_NA 源集群读写 S_RW_D_R 源集群读写目标集群读 S_RW_D_RW 源集群读写目标集群读写 S_R_D_RW 源集群读目标集群读写 S_NA_D_RW 目标集群读写 注意：此字段可能返回 null，表示取不到有效值。 示例值：S_RW_D_NA |
| HealthCheckPassed | Boolean | 是否完成健康检查 注意：此字段可能返回 null，表示取不到有效值。 示例值：false |
| HealthCheckError | String | 上次健康检查返回的错误信息，仅在HealthCheckPassed为false时有效。 NotChecked 未执行检查， Unknown 未知错误, TopicNotImported 主题未导入, TopicNotExistsInSourceCluster 主题在源集群中不存在, TopicNotExistsInTargetCluster 主题在目标集群中不存在, ConsumerConnectedOnTarget 目标集群上存在消费者连接, SourceTopicHasNewMessagesIn5Minutes 源集群主题前5分钟内有新消息写入, TargetTopicHasNewMessagesIn5Minutes 目标集群主题前5分钟内有新消息写入, SourceTopicHasNoMessagesIn5Minutes 源集群前5分钟内没有新消息写入, TargetTopicHasNoMessagesIn5Minutes 源集群前5分钟内没有新消息写入, ConsumerGroupCountNotMatch 订阅组数量不一致, SourceTopicHasUnconsumedMessages 源集群主题存在未消费消息, 注意：此字段可能返回 null，表示取不到有效值。 |
MsgLog
消息日志
被如下接口引用：DescribeTopicMsgs。
| 名称 | 类型 | 描述 |
|---|---|---|
| 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 |
PartitionsTopic
分区topic
被如下接口引用：DescribeTopics。
| 名称 | 类型 | 描述 |
|---|---|---|
| AverageMsgSize | String | 最后一次间隔内发布消息的平均byte大小。 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
| ConsumerCount | String | 消费者数量。 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
| LastConfirmedEntry | String | 被记录下来的消息总数。 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
| LastLedgerCreatedTimestamp | String | 最后一个ledger创建的时间。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-10-08 08:04:13,809 |
| MsgRateIn | String | 本地和复制的发布者每秒发布消息的速率。 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
| MsgRateOut | String | 本地和复制的消费者每秒分发消息的数量之和。 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
| MsgThroughputIn | String | 本地和复制的发布者每秒发布消息的byte。 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
| MsgThroughputOut | String | 本地和复制的消费者每秒分发消息的byte。 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
| NumberOfEntries | String | 被记录下来的消息总数。 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
| Partitions | Integer | 子分区id。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
| ProducerCount | String | 生产者数量。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
| TotalSize | String | 以byte计算的所有消息存储总量。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
| TopicType | Integer | topic类型描述。 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
ProducerLog
消息生产信息
被如下接口引用：DescribeMsgTrace。
| 名称 | 类型 | 描述 |
|---|---|---|
| MsgId | String | 消息ID。 示例值：6054156:22067:16 |
| ProducerName | String | 生产者名称。 示例值：pulsar-7dqvnqwjgzm-2156-9 |
| ProduceTime | String | 消息生产时间。 示例值：2024-10-08 14:45:52,636 |
| ProducerAddr | String | 生产者客户端。 示例值：10.0.0.120:38168 |
| ProduceUseTime | Integer | 生产耗时（秒）。 示例值：2 |
| Status | String | 状态。 示例值：success |
PrometheusEndpointInfo
rabbitmq Prometheus信息
被如下接口引用：DescribeRabbitMQVipInstance。
| 名称 | 类型 | 描述 |
|---|---|---|
| PrometheusEndpointStatus | String | Prometheus开关的状态。 注意：此字段可能返回 null，表示取不到有效值。 示例值：ON/OFF/CREATING/DELETEING |
| VpcPrometheusEndpoint | Array of String | prometheus信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：1.2.3.4:15692 |
| NodePrometheusAddress | Array of String | 节点信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：node1:15692 |
| VpcEndpointInfo | VpcEndpointInfo | vpc信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：vpc sunbet ip |
PublicAccessRule
公网访问安全规则
被如下接口引用：CreateRocketMQVipInstance, DescribeRocketMQPublicAccessPoint, SetRocketMQPublicAccessPoint。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| IpRule | String | 是 | ip网段信息 示例值：0.0.0.0/0 |
| Allow | Boolean | 是 | 允许或者拒绝 示例值：true |
| Remark | String | 否 | 备注信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：test remark info |
Publisher
生产者信息
被如下接口引用：DescribePublishers。
| 名称 | 类型 | 描述 |
|---|---|---|
| ProducerId | Integer | 生产者id 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| ProducerName | String | 生产者名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：pulsar-7dqvndn5jgzm-2156-9 |
| Address | String | 生产者地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：10.0.0.1:1234 |
| ClientVersion | String | 客户端版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：2.7.2 |
| MsgRateIn | Float | 消息生产速率（条/秒） 注意：此字段可能返回 null，表示取不到有效值。 示例值：21.233 |
| MsgThroughputIn | Float | 消息生产吞吐速率（字节/秒） 注意：此字段可能返回 null，表示取不到有效值。 示例值：21.3655 |
| AverageMsgSize | Float | 平均消息大小（字节） 注意：此字段可能返回 null，表示取不到有效值。 示例值：1233 |
| ConnectedSince | String | 连接时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：June |
| Partition | Integer | 生产者连接的主题分区号 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
PulsarNetworkAccessPointInfo
Pulsar 网络接入点信息
被如下接口引用：DescribePulsarProInstanceDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| VpcId | String | vpc的id，支撑网和公网接入点，该字段为空 注意：此字段可能返回 null，表示取不到有效值。 示例值：vpc-8jjiuayds |
| SubnetId | String | 子网id，支撑网和公网接入点，该字段为空 注意：此字段可能返回 null，表示取不到有效值。 示例值：subnet-1i12ofyz |
| Endpoint | String | 接入地址 示例值：ip:port |
| InstanceId | String | 实例id 示例值：pulsar-mw4qmgaq298g |
| RouteType | Integer | 接入点类型： 0：支撑网接入点 1：VPC接入点 2：公网接入点 示例值：1 |
| OperationType | Integer | 0：本地域访问，由于并没有配置跨地域容灾，所该类型的接入点，无法进行异地切换、异地访问切回； 1：本地域访问，由于配置了跨地域容灾，随时可以进行异地切换，该状态用于主集群的接入点 2：跨地域访问，已经完成了异地切换，该状态用于源集群的接入点，该状态下的接入点不可删除 3：跨地域访问，随时可以进行异地访问切回，该状态用于目标集群的接入点，该状态下的接入点不可删除 4:跨地域访问，目标集群已经完成异地切回，等待删除状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| AccessPointsType | String | 接入点类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：vpc |
| Bandwidth | Integer | 带宽，目前只有公网会有这个值 注意：此字段可能返回 null，表示取不到有效值。 示例值：3 |
| SecurityPolicy | Array of SecurityPolicy | 类 注意：此字段可能返回 null，表示取不到有效值。 |
| StandardAccessPoint | Boolean | 是否是标准的接入点 true是标准的 false不是标准的 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| ZoneName | String | 可用区信息 示例值：ap-beijing-4 |
PulsarProClusterInfo
Pulsar专业版集群信息
被如下接口引用：DescribePulsarProInstanceDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| ClusterId | String | 集群Id。 示例值：1000 |
| ClusterName | String | 集群名称。 示例值：pulsar-mw4qmgaq298g |
| Remark | String | 说明信息。 示例值：devRemark |
| CreateTime | String | 创建时间 示例值：2021-04-21 19:00:00 |
| Status | Integer | 集群状态，0:创建中，1:正常，2:隔离 示例值：1 |
| Version | String | 集群版本 示例值：2.5.1 |
| NodeDistribution | Array of InstanceNodeDistribution | 节点分布情况 注意：此字段可能返回 null，表示取不到有效值。 |
| MaxStorage | Integer | 最大储存容量，单位：MB 示例值：1000 |
| CanEditRoute | Boolean | 是否可以修改路由 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| BillingLabelVersion | String | 代表是专业版和小规格专业版的不同计费规格PULSAR.P1固定存储PULSAR.P2弹性存储 注意：此字段可能返回 null，表示取不到有效值。 示例值：PULSAR.P1/PULSAR.P2 |
| ExpireTime | Integer | 实例到期时间戳，毫秒级精度。 注意：此字段可能返回 null，表示取不到有效值。 示例值：1725165113283 |
| AutoCreateTopicStatus | Boolean | 是否开启自动创建主题 true就是开启了，false是关闭 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| DefaultPartitionNumber | Integer | 自动创建主题的默认分区数，如果没开启就是0 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
PulsarProClusterSpecInfo
Pulsar专业版集群规格信息
被如下接口引用：DescribePulsarProInstanceDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| SpecName | String | 集群规格名称 示例值：标准型 |
| MaxTps | Integer | 峰值tps 示例值：5000 |
| MaxBandWidth | Integer | 峰值带宽。单位：mbps 示例值：50 |
| MaxNamespaces | Integer | 最大命名空间个数 示例值：50 |
| MaxTopics | Integer | 最大主题分区数 示例值：4000 |
| ScalableTps | Integer | 规格外弹性TPS 注意：此字段可能返回 null，表示取不到有效值。 示例值：2000 |
| MaxPartitions | Integer | 32或者128 当前集群topic的最大分区数 注意：此字段可能返回 null，表示取不到有效值。 示例值：32 |
PulsarProInstance
Pulsar专业版实例信息
被如下接口引用：DescribePulsarProInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例id 示例值：pulsar-xxxx |
| InstanceName | String | 实例名称 示例值：cluster-test |
| InstanceVersion | String | 实例版本 示例值：2.7.2 |
| Status | Integer | 实例状态，0-创建中，1-正常，2-隔离中，3-已销毁，4 - 异常, 5 - 发货失败，6-变配中，7-变配失败 示例值：0 |
| ConfigDisplay | String | 实例配置规格名称 示例值：基础型 |
| MaxTps | Integer | 峰值TPS 示例值：10000 |
| MaxStorage | Integer | 存储容量，GB为单位 示例值：100 |
| ExpireTime | Integer | 实例到期时间，毫秒为单位 示例值：100000 |
| AutoRenewFlag | Integer | 自动续费标记，0表示默认状态(用户未设置，即初始状态即手动续费)， 1表示自动续费，2表示明确不自动续费(用户设置) 示例值：0 |
| PayMode | Integer | 0-后付费，1-预付费 示例值：0 |
| Remark | String | 备注信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：备注 |
| SpecName | String | 实例配置ID 示例值：vip-basic-1 |
| ScalableTps | Integer | 规格外弹性TPS 注意：此字段可能返回 null，表示取不到有效值。 示例值：1000 |
| VpcId | String | VPC的id 注意：此字段可能返回 null，表示取不到有效值。 示例值：vpc-xxxx |
| SubnetId | String | 子网id 注意：此字段可能返回 null，表示取不到有效值。 示例值：subnet-xxx |
| MaxBandWidth | Integer | 峰值带宽。单位：mbps 示例值：100 |
| Tags | Array of Tag | 集群的标签列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：[{ "TagKey": "aaa", "TagValue": "aaa" }] |
| CreateTime | String | 集群创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2023-12-08 10:25:51 |
| BillingLabelVersion | String | 代表是专业版和小规格专业版的不同计费规格PULSAR.P1固定存储PULSAR.P2弹性存储 注意：此字段可能返回 null，表示取不到有效值。 示例值：PULSAR.P1/PULSAR.P2 |
QueueQuota
queue使用配额信息
被如下接口引用：DescribeRabbitMQVipInstance。
| 名称 | 类型 | 描述 |
|---|---|---|
| MaxQueue | Integer | 可创建最大Queue数 示例值：10 |
| UsedQueue | Integer | 已创建Queue数 注意：此字段可能返回 null，表示取不到有效值。 示例值：5 |
RabbitMQBindingListInfo
Rabbitmq路由关系列表成员
被如下接口引用：DescribeRabbitMQBindings。
| 名称 | 类型 | 描述 |
|---|---|---|
| BindingId | Integer | 路由关系id 注意：此字段可能返回 null，表示取不到有效值。 示例值：123 |
| VirtualHost | String | Vhost参数 注意：此字段可能返回 null，表示取不到有效值。 示例值：testVhost |
| Source | String | 源exchange名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：testSource |
| DestinationType | String | 目标类型,queue或exchange 注意：此字段可能返回 null，表示取不到有效值。 示例值：queue |
| Destination | String | 目标资源名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：testDestination |
| RoutingKey | String | 绑定key 注意：此字段可能返回 null，表示取不到有效值。 示例值：testRoutingKey |
| SourceExchangeType | String | 源exchange类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：testSourceExchangeType |
| CreateTime | String | 创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2023-11-20 11:15:47.612 |
| ModifyTime | String | 修改时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2023-11-20 11:15:47.612 |
RabbitMQClusterAccessInfo
RabbitMQ集群访问信息
被如下接口引用：DescribeRabbitMQVipInstance。
| 名称 | 类型 | 描述 |
|---|---|---|
| PublicAccessEndpoint | String | 集群公网接入地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：101.10.10.101:5672 |
| WebConsoleEndpoint | String | 集群控制台访问地址 示例值：https://amqp-xx.com |
| WebConsoleUsername | String | 集群控制台登录用户名 示例值：username |
| WebConsolePassword | String | 集群控制台登录密码 示例值：56A1S61651fd56a1 |
| PublicAccessEndpointStatus | Boolean | 已废弃 示例值：true/false |
| PublicControlConsoleSwitchStatus | Boolean | 已废弃 示例值：true/false |
| VpcControlConsoleSwitchStatus | Boolean | 已废弃 示例值：true/false |
| VpcWebConsoleEndpoint | String | Vpc管控台访问地址，示例值，http://1.1.1.1:15672 示例值：http://1.1.1.1:15672 |
| PublicWebConsoleSwitchStatus | String | 公网管控台开关状态，示例值，OFF/ON/CREATING/DELETING 注意：此字段可能返回 null，表示取不到有效值。 示例值：OFF/ON/CREATING/DELETING |
| VpcWebConsoleSwitchStatus | String | Vpc管控台开关状态，示例值， OFF/ON/CREATING/DELETING 注意：此字段可能返回 null，表示取不到有效值。 示例值：OFF/ON/CREATING/DELETING |
| PublicDataStreamStatus | String | 公网管控台开关状态，示例值，OFF/ON/CREATING/DELETING 注意：此字段可能返回 null，表示取不到有效值。 示例值：OFF/ON/CREATING/DELETING |
| PrometheusEndpointInfo | PrometheusEndpointInfo | Prometheus信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：Prometheus信息 |
| WebConsoleDomainEndpoint | String | 公网域名接入点 注意：此字段可能返回 null，表示取不到有效值。 示例值：http://amqp-test.dashboard.rabbitmq.cq.public.tencenttdmq.com:15672/ |
RabbitMQClusterInfo
RabbiteMQ集群基本信息
被如下接口引用：DescribeRabbitMQVipInstance。
| 名称 | 类型 | 描述 |
|---|---|---|
| ClusterId | String | 集群ID 示例值：amqp-xxxxx |
| ClusterName | String | 集群名称 示例值：test |
| Region | String | 地域信息 示例值：华南地区 |
| CreateTime | Integer | 创建时间，毫秒为单位 示例值：1666257531142 |
| Remark | String | 集群说明信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：备注 |
| Vpcs | Array of VpcEndpointInfo | VPC及网络信息 |
| ZoneIds | Array of Integer | 可用区信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：[190001] |
| VirtualHostNumber | Integer | 虚拟主机数量 示例值：10 |
| QueueNumber | Integer | 队列数量 示例值：10 |
| MessagePublishRate | Float | 每秒生产消息数 单位：条/秒 示例值：2.3 |
| MessageStackNumber | Integer | 堆积消息数 单位：条 示例值：5 |
| ExpireTime | Integer | 过期时间 示例值：1666257531143 |
| ChannelNumber | Integer | Channel数量 示例值：10 |
| ConnectionNumber | Integer | Connection数量 示例值：10 |
| ConsumerNumber | Integer | Consumer数量 示例值：10 |
| ExchangeNumber | Integer | Exchang数量 示例值：10 |
| ExceptionInformation | String | 集群异常信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：异常信息 |
| ClusterStatus | Integer | 实例状态，0表示创建中，1表示正常，2表示隔离中，3表示已销毁，4 - 异常, 5 - 发货失败 示例值：0 |
| AutoRenewFlag | Integer | 自动续费标记，0表示默认状态(用户未设置，即初始状态即手动续费)， 1表示自动续费，2表示明确不自动续费(用户设置) 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| MirrorQueuePolicyFlag | Integer | 是否开启镜像队列策略。1表示开启，0表示没开启。 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| MessageConsumeRate | Float | 每秒消费消息数 单位：条/秒 注意：此字段可能返回 null，表示取不到有效值。 示例值：1.0 |
| ClusterVersion | String | 集群版本信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：3.8.30 |
| PayMode | Integer | 计费模式，0-后付费，1-预付费 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
RabbitMQClusterSpecInfo
RabbitMQ集群规格信息
被如下接口引用：DescribeRabbitMQVipInstance。
| 名称 | 类型 | 描述 |
|---|---|---|
| SpecName | String | 集群规格名称 示例值：标准型 |
| NodeCount | Integer | 节点数量 示例值：3 |
| MaxTps | Integer | 峰值tps 示例值：5000 |
| MaxBandWidth | Integer | 峰值带宽。单位：mbps 示例值：50 |
| MaxStorage | Integer | 存储容量。单位：GB 示例值：100 |
| PublicNetworkTps | Integer | 公网带宽tps。单位：Mbps 示例值：1 |
RabbitMQClusterWhiteListInfo
RabbiteMQ集群白名单信息
被如下接口引用：DescribeRabbitMQVipInstance。
| 名称 | 类型 | 描述 |
|---|---|---|
| WhiteList | String | 废弃 注意：此字段可能返回 null，表示取不到有效值。 示例值：1.2.3.4,5.6.7.8 |
| PublicControlConsoleWhiteList | String | 公网管控台白名单 注意：此字段可能返回 null，表示取不到有效值。 示例值：1.2.3.4,5.6.7.8 |
| PublicDataStreamWhiteList | String | 公网数据流白名单 注意：此字段可能返回 null，表示取不到有效值。 示例值：1.2.3.4,5.6.7.8 |
| PublicControlConsoleWhiteListStatus | String | 公网管控台白名单状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：OFF/ON/MODIFYING |
| PublicDataStreamWhiteListStatus | String | 公网数据流白名单状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：OFF/ON/MODIFYING |
RabbitMQExchangeListInfo
RabbitMQ exchange列表成员信息
被如下接口引用：DescribeRabbitMQExchanges。
| 名称 | 类型 | 描述 |
|---|---|---|
| ExchangeName | String | exchange 名 示例值：testExchangeName |
| Remark | String | 备注说明 注意：此字段可能返回 null，表示取不到有效值。 示例值：testRemark |
| ExchangeType | String | exchange 类型, 支持 "fanout","direct","topic","headers" 示例值：fanout |
| VirtualHost | String | VHost参数 注意：此字段可能返回 null，表示取不到有效值。 示例值：testVhost |
| ExchangeCreator | String | exchange 创建者, "system":"系统创建", "user":"用户创建" 注意：此字段可能返回 null，表示取不到有效值。 示例值：user |
| CreateTimeStamp | String | exchange 创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2016-11-09 11:44:44 |
| ModTimeStamp | String | exchange 修改时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2016-11-09 11:44:44 |
| MessageRateIn | Float | 输入消息速率 注意：此字段可能返回 null，表示取不到有效值。 示例值：0.0 |
| MessageRateOut | Float | 输出消息速率 注意：此字段可能返回 null，表示取不到有效值。 示例值：0.0 |
| Durable | Boolean | 是否为持久化交换机，true 为持久化，false 为非持久化 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| AutoDelete | Boolean | 是否为自动删除交换机，true 为自动删除，false 为非自动删除 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| Internal | Boolean | 是否为内部交换机，true 为内部交换机 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| InstanceId | String | 交换机所属实例 ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：amqp-xxx |
| Policy | String | 生效的策略名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：test-policy |
| Arguments | String | 扩展参数 key-value 对象 注意：此字段可能返回 null，表示取不到有效值。 示例值：{} |
| MessagesDelayed | Integer | 未调度的延时消息数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
RabbitMQPrivateNode
RabbitMQ节点信息
被如下接口引用：DescribeRabbitMQNodeList。
| 名称 | 类型 | 描述 |
|---|---|---|
| NodeName | String | 节点名字 注意：此字段可能返回 null，表示取不到有效值。 示例值：node-xx |
| NodeStatus | String | 节点状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：running/down |
| CPUUsage | String | CPU使用率 注意：此字段可能返回 null，表示取不到有效值。 示例值：10% |
| Memory | Integer | 内存使用情况，单位MB 注意：此字段可能返回 null，表示取不到有效值。 示例值：1024 |
| DiskUsage | String | 磁盘使用率 注意：此字段可能返回 null，表示取不到有效值。 示例值：20% |
| ProcessNumber | Integer | Rabbitmq的Erlang进程数 注意：此字段可能返回 null，表示取不到有效值。 示例值：1000 |
RabbitMQPrivateVirtualHost
RabbitMQ专享版云服务器
被如下接口引用：DescribeRabbitMQVirtualHostList。
| 名称 | 类型 | 描述 |
|---|---|---|
| VirtualHostName | String | 虚拟主机的名字 注意：此字段可能返回 null，表示取不到有效值。 示例值：amqp_xxx |
| Description | String | 虚拟主机的描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：desc |
RabbitMQQueueListConsumerDetailInfo
RabbitMQ队列列表消费者信息
被如下接口引用：DescribeRabbitMQQueues。
| 名称 | 类型 | 描述 |
|---|---|---|
| ConsumersNumber | Integer | 消费者数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
RabbitMQQueueListInfo
RabbitMQ队列列表成员信息
被如下接口引用：DescribeRabbitMQQueues。
| 名称 | 类型 | 描述 |
|---|---|---|
| QueueName | String | 队列名 示例值：testQueueName |
| Remark | String | 备注说明 注意：此字段可能返回 null，表示取不到有效值。 示例值：testRemark |
| ConsumerDetail | RabbitMQQueueListConsumerDetailInfo | 消费者信息 注意：此字段可能返回 null，表示取不到有效值。 |
| QueueType | String | 队列类型，取值 "classic"，"quorum" 注意：此字段可能返回 null，表示取不到有效值。 示例值：classic |
| MessageHeapCount | Integer | 消息堆积数 注意：此字段可能返回 null，表示取不到有效值。 示例值：20 |
| MessageRateIn | Float | 消息生产速率，每秒 注意：此字段可能返回 null，表示取不到有效值。 示例值：0.0 |
| MessageRateOut | Float | 消息消费速率，每秒 注意：此字段可能返回 null，表示取不到有效值。 示例值：0.0 |
| CreateTime | String | 创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-01-03 11:58:39.447 |
| ModifyTime | String | 修改时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-01-03 11:58:39.447 |
| Durable | Boolean | 队列是否持久化，true 为持久化，false 为非持久化 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| AutoDelete | Boolean | 队列是否为自动删除队列，true 为自动删除，false 为非自动删除 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| InstanceId | String | 队列所属实例 ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：amqp-xxx |
| VirtualHost | String | 队列所属虚拟主机名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：/ |
| Node | String | 队列所在主节点名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：rabbit@amqp-xxx.rabbitmq-broker-0 |
| Policy | String | 生效的策略名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：test-policy |
| Arguments | String | 扩展参数 key-value 对象 注意：此字段可能返回 null，表示取不到有效值。 示例值：{} |
| Exclusive | Boolean | 是否独占队列 注意：此字段可能返回 null，表示取不到有效值。 示例值：false |
RabbitMQUser
RabbitMQ用户实体详情
被如下接口引用：DescribeRabbitMQUser。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 集群实例Id 示例值：amqp-xxx |
| User | String | 用户名，登录时使用 示例值：test_user |
| Password | String | 密码，登录时使用 示例值：abc123 |
| Description | String | 用户描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：测试账号 |
| Tags | Array of String | 用户标签，用于决定改用户访问RabbitMQ Management的权限范围 注意：此字段可能返回 null，表示取不到有效值。 示例值：monitoring |
| CreateTime | String | 用户创建时间 示例值：2022-11-11 11:11:11 |
| ModifyTime | String | 用户最后修改时间 示例值：2022-11-11 11:11:11 |
| Type | String | 用户类型，System：系统创建，User：用户创建 示例值：System |
| MaxConnections | Integer | 单个用户最大可用连接数 注意：此字段可能返回 null，表示取不到有效值。 示例值：100 |
| MaxChannels | Integer | 单个用户最大可用通道数 注意：此字段可能返回 null，表示取不到有效值。 示例值：1000 |
RabbitMQVipInstance
RabbitMQ专享实例信息
被如下接口引用：DescribeRabbitMQVipInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例id 示例值：amqp-xxxx |
| InstanceName | String | 实例名称 示例值：test |
| InstanceVersion | String | 实例版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：3.11.8 |
| Status | Integer | 实例状态，0表示创建中，1表示正常，2表示隔离中，3表示已销毁，4 - 异常, 5 - 发货失败 示例值：0 |
| NodeCount | Integer | 节点数量 示例值：5 |
| ConfigDisplay | String | 实例配置规格名称 示例值：基础型 |
| MaxTps | Integer | 峰值TPS 示例值：10000 |
| MaxBandWidth | Integer | 峰值带宽，Mbps为单位 示例值：1200 |
| MaxStorage | Integer | 存储容量，GB为单位 示例值：100 |
| ExpireTime | Integer | 实例到期时间，毫秒为单位 示例值：100000 |
| AutoRenewFlag | Integer | 自动续费标记，0表示默认状态(用户未设置，即初始状态即手动续费)， 1表示自动续费，2表示明确不自动续费(用户设置) 示例值：0 |
| PayMode | Integer | 0-后付费，1-预付费 示例值：0 |
| Remark | String | 备注信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：xxx |
| SpecName | String | 实例配置ID 示例值：vip-basic-1 |
| ExceptionInformation | String | 集群异常。 注意：此字段可能返回 null，表示取不到有效值。 示例值：异常信息 |
| ClusterStatus | Integer | 实例状态，0表示创建中，1表示正常，2表示隔离中，3表示已销毁，4 - 异常, 5 - 发货失败 为了和计费区分开，额外开启一个状态位，用于显示。 示例值：0 |
| PublicAccessEndpoint | String | 公网接入点 注意：此字段可能返回 null，表示取不到有效值。 示例值：amqp://127.0.0.1:5672 |
| Vpcs | Array of VpcEndpointInfo | VPC 接入点列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：[] |
| CreateTime | Integer | 创建时间，毫秒为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：1666257531143 |
RabbitMQVirtualHostInfo
RabbitMQ的vhost详情
被如下接口引用：DescribeRabbitMQVirtualHost。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 集群实例Id 示例值：amqp-xxx |
| VirtualHost | String | vhost名 示例值：testVhost |
| Description | String | vhost描述信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：hello |
| Tags | Array of String | vhost标签 注意：此字段可能返回 null，表示取不到有效值。 示例值：shop,account |
| CreateTime | String | 创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2022-11-11 11:11:11 |
| ModifyTime | String | 修改时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2022-11-11 11:11:11 |
| VirtualHostStatistics | RabbitMQVirtualHostStatistics | vhost概览统计信息 注意：此字段可能返回 null，表示取不到有效值。 |
| TraceFlag | Boolean | 消息轨迹开关,true打开,false关闭 注意：此字段可能返回 null，表示取不到有效值。 示例值：false |
| Status | String | vhost状态，与原生控制台对应，有running、partial、stopped、unknown 注意：此字段可能返回 null，表示取不到有效值。 示例值：running |
| MessageHeapCount | Integer | 消息堆积数 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| MessageRateIn | Float | 输入消息速率 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| MessageRateOut | Float | 输出消息速率 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| MirrorQueuePolicyFlag | Boolean | 是否存在镜像队列策略，true 为存在，false 为不存 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
RabbitMQVirtualHostStatistics
vhost概览统计信息
被如下接口引用：DescribeRabbitMQVirtualHost。
| 名称 | 类型 | 描述 |
|---|---|---|
| CurrentQueues | Integer | 当前vhost的queue数量 示例值：1 |
| CurrentExchanges | Integer | 当前vhost的exchange数量 示例值：1 |
| CurrentConnections | Integer | 当前vhost的连接数量 示例值：1 |
| CurrentChannels | Integer | 当前vhost的channel数量 示例值：1 |
| CurrentUsers | Integer | 当前vhost的用户数量 示例值：1 |
RetentionPolicy
消息保留策略
被如下接口引用：CreateEnvironment, DescribeEnvironments, ModifyEnvironmentAttributes。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TimeInMinutes | Integer | 是 | 消息保留时长 示例值：0 |
| SizeInMB | Integer | 是 | 消息保留大小 示例值：0 |
RocketMQClusterConfig
RocketMQ集群配置
被如下接口引用：DescribeRocketMQCluster, DescribeRocketMQClusters。
| 名称 | 类型 | 描述 |
|---|---|---|
| MaxTpsPerNamespace | Integer | 单命名空间TPS上线 示例值：8000 |
| MaxNamespaceNum | Integer | 最大命名空间数量 示例值：10 |
| UsedNamespaceNum | Integer | 已使用命名空间数量 示例值：3 |
| MaxTopicNum | Integer | 最大Topic数量 示例值：1000 |
| UsedTopicNum | Integer | 已使用Topic数量 示例值：8 |
| MaxGroupNum | Integer | 最大Group数量 示例值：10000 |
| UsedGroupNum | Integer | 已使用Group数量 示例值：10 |
| MaxRetentionTime | Integer | 消息最大保留时间，以毫秒为单位 示例值：100000 |
| MaxLatencyTime | Integer | 消息最长延时，以毫秒为单位 示例值：100000 |
| MaxQueuesPerTopic | Integer | 单个主题最大队列数 注意：此字段可能返回 null，表示取不到有效值。 示例值：16 |
| TopicDistribution | Array of RocketMQTopicDistribution | topic分布 注意：此字段可能返回 null，表示取不到有效值。 |
RocketMQClusterDetail
租户RocketMQ集群详细信息
被如下接口引用：DescribeRocketMQClusters。
| 名称 | 类型 | 描述 |
|---|---|---|
| Info | RocketMQClusterInfo | 集群基本信息 |
| Config | RocketMQClusterConfig | 集群配置信息 |
| Status | Integer | 集群状态，0:创建中，1:正常，2:销毁中，3:已删除，4: 隔离中，5:创建失败，6: 删除失败 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
RocketMQClusterInfo
RocketMQ集群基本信息
被如下接口引用：DescribeRocketMQCluster, DescribeRocketMQClusters, DescribeRocketMQVipInstanceDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| ClusterId | String | 集群ID 示例值：rocketmq-4k4orqgq |
| ClusterName | String | 集群名称 示例值：rocket-order-instance |
| Region | String | 地域信息 示例值：华南地区 |
| CreateTime | Integer | 创建时间，毫秒为单位 示例值：1729478721 |
| Remark | String | 集群说明信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：info-remark |
| PublicEndPoint | String | 公网接入地址 示例值：rocketmq.access.public.com:9867 |
| VpcEndPoint | String | VPC接入地址 示例值：rocketmq.resource.vpc.com:5010 |
| SupportNamespaceEndpoint | Boolean | 是否支持命名空间接入点 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| Vpcs | Array of VpcConfig | VPC信息 注意：此字段可能返回 null，表示取不到有效值。 |
| IsVip | Boolean | 是否为专享实例 注意：此字段可能返回 null，表示取不到有效值。 示例值：false |
| RocketMQFlag | Boolean | Rocketmq集群标识 注意：此字段可能返回 null，表示取不到有效值。 示例值：false |
| Status | Integer | 计费状态，1表示正常，2表示已停服，3表示已销毁 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| IsolateTime | Integer | 欠费停服时间，毫秒为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：1729478721 |
| HttpPublicEndpoint | String | HTTP协议公网接入地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：http://ip:port |
| HttpVpcEndpoint | String | HTTP协议VPC接入地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：http://ip:port |
| InternalEndpoint | String | TCP内部接入地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：namespace.internal:port |
| HttpInternalEndpoint | String | HTTP协议内部接入地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：http://ip:port |
| AclEnabled | Boolean | 是否开启ACL鉴权，专享实例支持关闭 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| PublicClbId | String | 公网CLB实例ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：clbId |
| Vip | String | vip 注意：此字段可能返回 null，表示取不到有效值。 示例值：vip |
| VpcId | String | 所属VPC 注意：此字段可能返回 null，表示取不到有效值。 示例值：mqvpc296 |
| SupportMigration | Boolean | 是否支持迁移 注意：此字段可能返回 null，表示取不到有效值。 示例值：false |
| InstanceStatus | Integer | 实例状态，0表示创建中，1表示正常，2表示隔离中，3表示已销毁，4 - 异常, 5 - 发货失败，6 - 变配中，7 - 变配失败 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| ZoneId | Integer | 集群所属可用区，表明集群归属的可用区 注意：此字段可能返回 null，表示取不到有效值。 示例值：100001 |
| ZoneIds | Array of Integer | 集群节点所在的可用区，若该集群为跨可用区集群，则包含该集群节点所在的多个可用区。 注意：此字段可能返回 null，表示取不到有效值。 示例值：[100001] |
RocketMQClusterRecentStats
RocketMQ近期使用量
被如下接口引用：DescribeRocketMQCluster。
| 名称 | 类型 | 描述 |
|---|---|---|
| TopicNum | Integer | Topic数量 示例值：20 |
| ProducedMsgNum | Integer | 消息生产数 示例值：11000 |
| ConsumedMsgNum | Integer | 消息消费数 示例值：11200 |
| AccumulativeMsgNum | Integer | 消息堆积数 示例值：22000 |
RocketMQConsumerConnection
在线消费者情况
被如下接口引用：DescribeRocketMQConsumerConnections。
| 名称 | 类型 | 描述 |
|---|---|---|
| ClientId | String | 消费者实例ID 示例值：rocketmq-2p9vx3ax9jxg |
| ClientAddr | String | 消费者实例的地址和端口 示例值：192.168.0.1:5555 |
| Language | String | 消费者应用的语言版本 示例值：JAVA |
| Accumulative | Integer | 消息堆积量 示例值：100 |
| Version | String | 消费端版本 示例值：V4.9.7 |
RocketMQConsumerTopic
消费者详情中的主题信息
被如下接口引用：DescribeRocketMQConsumerConnectionDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| Topic | String | 主题名称 示例值：test_topic |
| Type | String | 主题类型，Normal表示普通，GlobalOrder表示全局顺序，PartitionedOrder表示局部顺序，Transaction表示事务，Retry表示重试，DeadLetter表示死信 示例值：Normal |
| PartitionNum | Integer | 分区数 示例值：3 |
| Accumulative | Integer | 消息堆积数 示例值：100 |
| LastConsumptionTime | Integer | 最后消费时间，以毫秒为单位 示例值：1697945990000 |
| SubRule | String | 订阅规则 注意：此字段可能返回 null，表示取不到有效值。 示例值：* |
RocketMQDataPoint
监控数据点
被如下接口引用：DescribeRocketMQPublicAccessMonitorData。
| 名称 | 类型 | 描述 |
|---|---|---|
| Timestamps | Array of Integer | 监控值数组，该数组和Timestamps一一对应 注意：此字段可能返回 null，表示取不到有效值。 |
| Values | Array of Float | 监控数据点位置，比如一天按分钟划分有1440个点，每个点的序号是0 - 1439之间的一个数，当某个序号不在该数组中，说明掉点了 注意：此字段可能返回 null，表示取不到有效值。 |
RocketMQGroup
RocketMQ消费组信息
被如下接口引用：DescribeRocketMQConsumerConnections, DescribeRocketMQGroups。
| 名称 | 类型 | 描述 |
|---|---|---|
| Name | String | 消费组名称 示例值：test_group |
| ConsumerNum | Integer | 在线消费者数量 示例值：2 |
| TPS | Integer | 消费TPS 示例值：100 |
| TotalAccumulative | Integer | 总堆积数量 示例值：380 |
| ConsumptionMode | Integer | 0表示集群消费模式，1表示广播消费模式，-1表示未知 示例值：0 |
| ReadEnabled | Boolean | 是否允许消费 示例值：true |
| RetryPartitionNum | Integer | 重试队列分区数 注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
| CreateTime | Integer | 创建时间，以毫秒为单位 示例值：1729478721 |
| UpdateTime | Integer | 修改时间，以毫秒为单位 示例值：1729478721 |
| ClientProtocol | String | 客户端协议 示例值：tcp |
| Remark | String | 说明信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：备注信息 |
| ConsumerType | String | 消费者类型，枚举值ACTIVELY, PASSIVELY 注意：此字段可能返回 null，表示取不到有效值。 示例值：PUSH |
| BroadcastEnabled | Boolean | 是否开启广播消费 示例值：false |
| GroupType | String | Group类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：TCP |
| RetryMaxTimes | Integer | 重试次数 注意：此字段可能返回 null，表示取不到有效值。 示例值：16 |
RocketMQGroupConfig
RocketMQ消费组配置信息
被如下接口引用：ImportRocketMQConsumerGroups。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Namespace | String | 是 | 命名空间 示例值：xxxx |
| GroupName | String | 是 | 消费组名称 示例值：xxxx |
| ConsumeBroadcastEnable | Boolean | 是 | 是否开启广播消费 示例值：false |
| ConsumeEnable | Boolean | 是 | 是否开启消费 示例值：false |
| Remark | String | 否 | 备注信息 示例值：备注信息 |
| ConsumerGroupType | String | 否 | 协议类型，支持以下枚举值 TCP; HTTP; 示例值：TCP |
RocketMQGroupConfigOutput
RocketMQ消费组配置信息
被如下接口引用：DescribeRocketMQSourceClusterGroupList。
| 名称 | 类型 | 描述 |
|---|---|---|
| Namespace | String | 命名空间 注意：此字段可能返回 null，表示取不到有效值。 示例值：xxxx |
| GroupName | String | 消费组名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：xxxx |
| Imported | Boolean | 导入状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| Remark | String | remark 注意：此字段可能返回 null，表示取不到有效值。 |
RocketMQInstanceConfig
RocketMQ专享集群实例配置
被如下接口引用：DescribeRocketMQVipInstanceDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| MaxTpsPerNamespace | Integer | 单命名空间TPS上线 示例值：8000 |
| MaxNamespaceNum | Integer | 最大命名空间数量 示例值：10 |
| UsedNamespaceNum | Integer | 已使用命名空间数量 示例值：3 |
| MaxTopicNum | Integer | 最大Topic数量 示例值：1000 |
| UsedTopicNum | Integer | 已使用Topic数量 示例值：8 |
| MaxGroupNum | Integer | 最大Group数量 示例值：10000 |
| UsedGroupNum | Integer | 已使用Group数量 示例值：10 |
| ConfigDisplay | String | 集群类型 示例值：标准版 |
| NodeCount | Integer | 集群节点数 示例值：2 |
| NodeDistribution | Array of InstanceNodeDistribution | 节点分布情况 |
| TopicDistribution | Array of RocketMQTopicDistribution | topic分布情况 |
| MaxQueuesPerTopic | Integer | 每个主题最大队列数 注意：此字段可能返回 null，表示取不到有效值。 示例值：16 |
| MaxRetention | Integer | 最大可设置消息保留时间，小时为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：168 |
| MinRetention | Integer | 最小可设置消息保留时间，小时为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：24 |
| Retention | Integer | 实例消息保留时间，小时为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：72 |
| TopicNumLowerLimit | Integer | Topic个数最小配额，即免费额度，默认为集群规格单节点最小配额*节点个数 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| TopicNumUpperLimit | Integer | Topic个数最大配额，默认为集群规格单节点最大配额*节点个数 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
RocketMQMessageTrack
Rocketmq消息消费track信息
被如下接口引用：DescribeRocketMQMsg。
| 名称 | 类型 | 描述 |
|---|---|---|
| Group | String | 消费者组 示例值：test_group |
| ConsumeStatus | String | 消费状态, CONSUMED: 已消费 CONSUMED_BUT_FILTERED: 已过滤 NOT_CONSUME: 未消费 ENTER_RETRY: 进入重试队列 ENTER_DLQ: 进入死信队列 UNKNOWN: 查询不到消费状态 示例值：CONSUMED |
| TrackType | String | 消息track类型 示例值：CONSUMED_BUT_FILTERED |
| ExceptionDesc | String | 异常信息 注意：此字段可能返回 null，表示取不到有效值。 示例值："" |
RocketMQMigrationTopicDistribution
迁移主题的阶段分布
被如下接口引用：DescribeRocketMQSmoothMigrationTask。
| 名称 | 类型 | 描述 |
|---|---|---|
| Stage | String | 迁移主题阶段 注意：此字段可能返回 null，表示取不到有效值。 |
| Count | Integer | 数量 注意：此字段可能返回 null，表示取不到有效值。 |
RocketMQMsgLog
rocketmq消息日志
被如下接口引用：DescribeRocketMQTopicMsgs。
| 名称 | 类型 | 描述 |
|---|---|---|
| MsgId | String | 消息id 示例值：092BAE5A1656070DEA4E276DF0760089 |
| MsgTag | String | 消息tag 注意：此字段可能返回 null，表示取不到有效值。 示例值：test_tag |
| MsgKey | String | 消息key 注意：此字段可能返回 null，表示取不到有效值。 示例值：test_key |
| ProducerAddr | String | 客户端地址 示例值：9.43.174.90 |
| ProduceTime | String | 消息发送时间 示例值：2023-10-08 15:45:16 |
| PulsarMsgId | String | pulsar消息id 示例值：092BAE5A1656070DEA4E276DF0760089 |
| DeadLetterResendTimes | Integer | 死信重发次数 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
| ResendSuccessCount | Integer | 死信重发成功次数 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
RocketMQNamespace
RocketMQ命名空间信息
被如下接口引用：DescribeRocketMQNamespaces。
| 名称 | 类型 | 描述 |
|---|---|---|
| NamespaceId | String | 命名空间名称，3-64个字符，只能包含字母、数字、“-”及“_” 示例值：prod |
| Ttl | Integer | 已废弃，未消费消息的保留时间，以毫秒单位，范围60秒到15天 示例值：100000 |
| RetentionTime | Integer | 消息持久化后保留的时间，以毫秒单位 示例值：10000 |
| Remark | String | 说明 注意：此字段可能返回 null，表示取不到有效值。 示例值：备注 |
| PublicEndpoint | String | 公网接入点地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：http://ip:port |
| VpcEndpoint | String | VPC接入点地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：http://ip:port |
| InternalEndpoint | String | 内部接入点地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：http://ip:port |
RocketMQSmoothMigrationTaskItem
RocketMQ平滑迁移任务
被如下接口引用：DescribeRocketMQSmoothMigrationTaskList。
| 名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 任务ID 注意：此字段可能返回 null，表示取不到有效值。 |
| TaskName | String | 任务名称 注意：此字段可能返回 null，表示取不到有效值。 |
| SourceClusterName | String | 源集群名称 注意：此字段可能返回 null，表示取不到有效值。 |
| ClusterId | String | 目标集群ID 注意：此字段可能返回 null，表示取不到有效值。 |
| ConnectionType | String | 网络连接类型， PUBLIC 公网 VPC 私有网络 OTHER 其他 注意：此字段可能返回 null，表示取不到有效值。 |
| SourceNameServer | String | 源集群NameServer地址 注意：此字段可能返回 null，表示取不到有效值。 |
| TaskStatus | String | 任务状态 Configuration 迁移配置 SourceConnecting 连接源集群中 MetaDataImport 元数据导入 EndpointSetup 切换接入点 ServiceMigration 切流中 Completed 已完成 Cancelled 已取消 注意：此字段可能返回 null，表示取不到有效值。 |
RocketMQSubscription
RocketMQ消费组订阅信息
被如下接口引用：DescribeRocketMQSubscriptions, DescribeRocketMQTopics。
| 名称 | 类型 | 描述 |
|---|---|---|
| Topic | String | 主题名称 示例值：test_topic |
| Type | String | 主题类型： Normal 普通, GlobalOrder 全局顺序, PartitionedOrder 局部顺序, Transaction 事务消息, DelayScheduled 延时消息, Retry 重试, DeadLetter 死信 注意：此字段可能返回 null，表示取不到有效值。 示例值：DeadLetter |
| PartitionNum | Integer | 分区数 注意：此字段可能返回 null，表示取不到有效值。 示例值：3 |
| ExpressionType | String | 过滤模式，TAG，SQL 注意：此字段可能返回 null，表示取不到有效值。 示例值：TAG |
| SubString | String | 过滤表达式 注意：此字段可能返回 null，表示取不到有效值。 示例值：* |
| Status | Integer | 订阅状态： 0，订阅关系一致 1，订阅关系不一致 2，未知 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| ConsumerLag | Integer | 消费堆积数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：260 |
| ClusterId | String | 实例ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：rocketmq-2p9vx3ax9jxg |
| ConsumerGroup | String | 消费组名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：test_group |
| IsOnline | Boolean | 是否在线 注意：此字段可能返回 null，表示取不到有效值。 示例值：false |
| ConsumeType | Integer | 消费类型 0: 广播消费 1: 集群消费 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| Consistency | Integer | 订阅一致性 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| LastUpdateTime | Integer | 最后消费进度更新时间，秒为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：1727420571 |
| MaxRetryTimes | Integer | 最大重试次数 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
| ClientProtocol | String | 协议类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：TCP/HTTP |
| ClientSubscriptionInfos | Array of ClientSubscriptionInfo | 客户端订阅详情 注意：此字段可能返回 null，表示取不到有效值。 示例值：[] |
RocketMQTopic
RocketMQ主题信息
被如下接口引用：DescribeRocketMQTopics。
| 名称 | 类型 | 描述 |
|---|---|---|
| Name | String | 主题名称 示例值：test_topic |
| Type | String | 主题的类别，为枚举类型，Normal，GlobalOrder，PartitionedOrder，Transaction，Retry及DeadLetter 示例值：Normal |
| GroupNum | Integer | 订阅组数量 示例值：5 |
| Remark | String | 说明 注意：此字段可能返回 null，表示取不到有效值。 示例值：备注信息 |
| PartitionNum | Integer | 读写分区数 示例值：3 |
| CreateTime | Integer | 创建时间，以毫秒为单位 示例值：100000 |
| UpdateTime | Integer | 创建时间，以毫秒为单位 示例值：100000 |
| LastUpdateTime | Integer | 最后写入时间，单位为秒 注意：此字段可能返回 null，表示取不到有效值。 示例值：1727420571 |
| SubscriptionCount | Integer | 订阅数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
| SubscriptionData | Array of RocketMQSubscription | 订阅关系列表 注意：此字段可能返回 null，表示取不到有效值。 |
RocketMQTopicConfig
RocketMQ主题配置信息
被如下接口引用：ImportRocketMQTopics。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Namespace | String | 是 | 命名空间 示例值：xxx |
| TopicName | String | 是 | 主题名称 示例值：xxxx |
| Type | String | 是 | 主题类型： Normal，普通 PartitionedOrder, 分区顺序 Transaction，事务消息 DelayScheduled，延迟/定时消息 示例值：Normal |
| Partitions | Integer | 是 | 分区个数 示例值：1 |
| Remark | String | 否 | 备注信息 示例值：备注信息 |
RocketMQTopicConfigOutput
RocketMQ主题配置信息
被如下接口引用：DescribeRocketMQSourceClusterTopicList。
| 名称 | 类型 | 描述 |
|---|---|---|
| Namespace | String | 命名空间 注意：此字段可能返回 null，表示取不到有效值。 示例值：xxx |
| TopicName | String | 主题名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：xxxx |
| Type | String | 主题类型： Normal，普通 GlobalOrder， 全局顺序 PartitionedOrder, 分区顺序 Transaction，事务消息 DelayScheduled，延迟/定时消息 注意：此字段可能返回 null，表示取不到有效值。 示例值：Normal |
| Partitions | Integer | 分区个数 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| Remark | String | 备注信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：备注信息 |
| Imported | Boolean | 是否导入 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
RocketMQTopicDistribution
RocketMQtopic分布情况
被如下接口引用：DescribeRocketMQCluster, DescribeRocketMQSmoothMigrationTask, DescribeRocketMQVipInstanceDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| TopicType | String | topic类型 示例值：Normal |
| Count | Integer | topic数量 示例值：10 |
RocketMQVipInstance
RocketMQ专享实例信息
被如下接口引用：DescribeRocketMQVipInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例id 示例值：rmq-4k4orqgq1 |
| InstanceName | String | 实例名称 示例值：order-instance |
| InstanceVersion | String | 实例版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：4.9.3 |
| Status | Integer | 实例状态，0表示创建中，1表示正常，2表示隔离中，3表示已销毁，4 - 异常, 5 - 发货失败，6 - 变配中，7 - 变配失败 示例值：0 |
| NodeCount | Integer | 节点数量 示例值：5 |
| ConfigDisplay | String | 实例配置规格名称 示例值：基础型 |
| MaxTps | Integer | 峰值TPS 示例值：10000 |
| MaxBandWidth | Integer | 峰值带宽，Mbps为单位 示例值：1200 |
| MaxStorage | Integer | 存储容量，GB为单位 示例值：100 |
| ExpireTime | Integer | 实例到期时间，毫秒为单位 示例值：100000 |
| AutoRenewFlag | Integer | 自动续费标记，0表示默认状态(用户未设置，即初始状态即手动续费)， 1表示自动续费，2表示明确不自动续费(用户设置) 示例值：0 |
| PayMode | Integer | 0-后付费，1-预付费 示例值：0 |
| Remark | String | 备注信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：remark-info |
| SpecName | String | 实例配置ID 示例值：vip-basic-1 |
| MaxRetention | Integer | 最大可设置消息保留时间，小时为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：168 |
| MinRetention | Integer | 最小可设置消息保留时间，小时为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：24 |
| Retention | Integer | 实例消息保留时间，小时为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：72 |
| AclEnabled | Boolean | 是否开启ACL鉴权 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| DestroyTime | Integer | 销毁时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：369182637452345 |
Role
角色实例
被如下接口引用：DescribeRocketMQRoles, DescribeRoles。
| 名称 | 类型 | 描述 |
|---|---|---|
| RoleName | String | 角色名称。 示例值：test_role_name |
| Token | String | 角色token值。 示例值：eyJrZXlJZCI6InN1bmdvxxxxx0X3JvbGVfMyJ9.dbHR8m6gc4L4vZUrodhW_O9bDulZQ6lraNswNLtcUcY |
| Remark | String | 备注说明。 示例值：测试账号 |
| CreateTime | Timestamp | 创建时间。 示例值：2020-09-22 00:00:00 |
| UpdateTime | Timestamp | 更新时间。 示例值：2020-09-22 00:00:00 |
SecurityPolicy
安全策略
被如下接口引用：DescribePulsarProInstanceDetail。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Route | String | 否 | ip或者网段 注意：此字段可能返回 null，表示取不到有效值。 示例值：1.1.1.1 |
| Policy | Boolean | 否 | 策略 true就是允许，白名单或者 false 拒绝 黑名单 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| Remark | String | 否 | 备注 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
ServerLog
服务方信息
被如下接口引用：DescribeMsgTrace。
| 名称 | 类型 | 描述 |
|---|---|---|
| SaveTime | String | 存储时间。 示例值：2024-10-08 11:38:48,068 |
| Status | String | 状态。 示例值：success |
Sort
排序器
被如下接口引用：DescribePublishers。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 是 | 排序字段 示例值：msgRateIn |
| Order | String | 是 | 升序ASC，降序DESC 示例值：ASC |
Subscription
订阅者
被如下接口引用：DescribeSubscriptions。
| 名称 | 类型 | 描述 |
|---|---|---|
| TopicName | String | 主题名称。 示例值：devTopic |
| EnvironmentId | String | 环境（命名空间）名称。 示例值：devNs |
| ConnectedSince | String | 消费者开始连接的时间。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-09-12T16:01:59.677+08:00 |
| ConsumerAddr | String | 消费者地址。 注意：此字段可能返回 null，表示取不到有效值。 示例值：127.0.0.1 |
| ConsumerCount | String | 消费者数量。 注意：此字段可能返回 null，表示取不到有效值。 示例值：11 |
| ConsumerName | String | 消费者名称。 注意：此字段可能返回 null，表示取不到有效值。 示例值：devConsumerName |
| MsgBacklog | String | 堆积的消息数量。 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| MsgRateExpired | String | 于TTL，此订阅下没有被发送而是被丢弃的比例。 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| MsgRateOut | String | 消费者每秒分发消息的数量之和。 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| MsgThroughputOut | String | 消费者每秒消息的byte。 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| SubscriptionName | String | 订阅名称。 注意：此字段可能返回 null，表示取不到有效值。 示例值：devSubscriptionName |
| ConsumerSets | Array of Consumer | 消费者集合。 注意：此字段可能返回 null，表示取不到有效值。 |
| IsOnline | Boolean | 是否在线。 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| ConsumersScheduleSets | Array of ConsumersSchedule | 消费进度集合。 注意：此字段可能返回 null，表示取不到有效值。 |
| Remark | String | 备注。 注意：此字段可能返回 null，表示取不到有效值。 示例值：devRemark |
| CreateTime | Timestamp | 创建时间。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2023-10-05 14:30:00 |
| UpdateTime | Timestamp | 最近修改时间。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2023-12-05 14:30:00 |
| SubType | String | 订阅类型，Exclusive，Shared，Failover， Key_Shared，空或NULL表示未知， 注意：此字段可能返回 null，表示取不到有效值。 示例值：Shared |
| BlockedSubscriptionOnUnackedMsgs | Boolean | 是否由于未 ack 数到达上限而被 block 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| MaxUnackedMsgNum | Integer | 未 ack 消息数上限 注意：此字段可能返回 null，表示取不到有效值。 示例值：5000 |
SubscriptionTopic
订阅关系
被如下接口引用：DeleteSubscriptions。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| EnvironmentId | String | 是 | 环境（命名空间）名称。 示例值：devNs |
| TopicName | String | 是 | 主题名称。 示例值：devTopic |
| SubscriptionName | String | 是 | 订阅名称。 示例值：devSub |
Tag
标签的key/value的类型
被如下接口引用：CreateCluster, CreateCmqQueue, CreateCmqTopic, CreateProCluster, CreateRabbitMQVipInstance, CreateRocketMQVipInstance, DescribeAMQPClusters, DescribeClusterDetail, DescribeClusters, DescribeCmqQueueDetail, DescribeCmqQueues, DescribeCmqTopicDetail, DescribeCmqTopics, DescribePulsarProInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TagKey | String | 是 | 标签的key的值 注意：此字段可能返回 null，表示取不到有效值。 示例值：test_tag_key |
| TagValue | String | 是 | 标签的Value的值 注意：此字段可能返回 null，表示取不到有效值。 示例值：test_tag_value1 |
Topic
主题实例
被如下接口引用：DescribeTopics。
| 名称 | 类型 | 描述 |
|---|---|---|
| AverageMsgSize | String | 最后一次间隔内发布消息的平均byte大小。 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
| ConsumerCount | String | 消费者数量。 注意：此字段可能返回 null，表示取不到有效值。 示例值：120 |
| LastConfirmedEntry | String | 被记录下来的消息总数。 注意：此字段可能返回 null，表示取不到有效值。 示例值：100 |
| LastLedgerCreatedTimestamp | String | 最后一个ledger创建的时间。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-06-19 14:15:54 |
| MsgRateIn | String | 本地和复制的发布者每秒发布消息的速率。 注意：此字段可能返回 null，表示取不到有效值。 示例值：130 |
| MsgRateOut | String | 本地和复制的消费者每秒分发消息的数量之和。 注意：此字段可能返回 null，表示取不到有效值。 示例值：140 |
| MsgThroughputIn | String | 本地和复制的发布者每秒发布消息的byte。 注意：此字段可能返回 null，表示取不到有效值。 示例值：160 |
| MsgThroughputOut | String | 本地和复制的消费者每秒分发消息的byte。 注意：此字段可能返回 null，表示取不到有效值。 示例值：120 |
| NumberOfEntries | String | 被记录下来的消息总数。 注意：此字段可能返回 null，表示取不到有效值。 示例值：100 |
| Partitions | Integer | 分区数<=0：topic下无子分区。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
| ProducerCount | String | 生产者数量。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
| TotalSize | String | 以byte计算的所有消息存储总量。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
| SubTopicSets | Array of PartitionsTopic | 分区topic里面的子分区。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
| TopicType | Integer | topic类型描述： 0：普通消息； 1：全局顺序消息； 2：局部顺序消息； 3：重试队列； 4：死信队列； 5：事务消息。 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| EnvironmentId | String | 环境（命名空间）名称。 注意：此字段可能返回 null，表示取不到有效值。 示例值：devNs |
| TopicName | String | 主题名称。 注意：此字段可能返回 null，表示取不到有效值。 示例值：devTopic |
| Remark | String | 说明，128个字符以内。 注意：此字段可能返回 null，表示取不到有效值。 示例值：devRemark |
| CreateTime | Timestamp | 创建时间。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-06-19 14:15:54 |
| UpdateTime | Timestamp | 最近修改时间。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-06-19 14:15:54 |
| ProducerLimit | String | 生产者上限。 注意：此字段可能返回 null，表示取不到有效值。 示例值：5000 |
| ConsumerLimit | String | 消费者上限。 注意：此字段可能返回 null，表示取不到有效值。 示例值：5000 |
| PulsarTopicType | Integer | 0: 非持久非分区 1: 非持久分区 2: 持久非分区 3: 持久分区 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| MsgTTL | Integer | 未消费消息过期时间，单位：秒 注意：此字段可能返回 null，表示取不到有效值。 示例值：60 |
TopicRecord
主题关键信息
被如下接口引用：DeleteTopics。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| EnvironmentId | String | 是 | 环境（命名空间）名称。 示例值：devNs |
| TopicName | String | 是 | 主题名称。 示例值：devTopic |
TopicStats
Topic状态
被如下接口引用：DescribeRocketMQTopicStats。
| 名称 | 类型 | 描述 |
|---|---|---|
| BrokerName | String | 所属Broker节点 注意：此字段可能返回 null，表示取不到有效值。 示例值：broker-1 |
| QueueId | Integer | 队列编号 注意：此字段可能返回 null，表示取不到有效值。 示例值：3 |
| MinOffset | Integer | 最小位点 注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
| MaxOffset | Integer | 最大位点 注意：此字段可能返回 null，表示取不到有效值。 示例值：7 |
| MessageCount | Integer | 消息条数 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
| LastUpdateTimestamp | Integer | 消息最后写入时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1727422630 |
TraceResult
消息轨迹结果
被如下接口引用：DescribeMqMsgTrace, DescribeRocketMQMsgTrace。
| 名称 | 类型 | 描述 |
|---|---|---|
| Stage | String | 阶段 示例值：produce |
| Data | String | 内容详情 示例值：{"", ""} |
VirtualHostQuota
vhost使用配额信息
被如下接口引用：DescribeRabbitMQVipInstance。
| 名称 | 类型 | 描述 |
|---|---|---|
| MaxVirtualHost | Integer | 允许创建最大vhost数 示例值：10 |
| UsedVirtualHost | Integer | 已创建vhost数 注意：此字段可能返回 null，表示取不到有效值。 示例值：4 |
VpcBindRecord
vcp绑定记录
被如下接口引用：DescribeBindVpcs。
| 名称 | 类型 | 描述 |
|---|---|---|
| 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 | Integer | Vpc的Port 示例值：8080 |
| Remark | String | 说明，128个字符以内 注意：此字段可能返回 null，表示取不到有效值。 示例值：devRemark |
VpcConfig
VPC配置信息
被如下接口引用：DescribeRocketMQCluster, DescribeRocketMQVipInstanceDetail。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| VpcId | String | 是 | vpc的id 示例值：vpc-9dlrd5h1 |
| SubnetId | String | 是 | 子网id 示例值：subnet-jadmas |
VpcEndpointInfo
VPC接入点信息
被如下接口引用：DescribeRabbitMQVipInstance, DescribeRabbitMQVipInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| VpcId | String | 是 | vpc的id 示例值：vpc-xxxx |
| SubnetId | String | 是 | 子网id 示例值：subnet-xxx |
| VpcEndpoint | String | 是 | vpc接入点信息 示例值：ip:port |
| VpcDataStreamEndpointStatus | String | 否 | vpc接入点状态 OFF/ON/CREATING/DELETING 注意：此字段可能返回 null，表示取不到有效值。 示例值：OFF/ON/CREATING/DELETING |
VpcInfo
vpc信息（由UniqVpcId和UniqSubnetId组成）
被如下接口引用：CreateProCluster, CreateRocketMQVipInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| VpcId | String | 是 | vpc信息 示例值：vpc-9dlrd5h1 |
| SubnetId | String | 是 | 子网信息 示例值：subnet-jadmas |
