数据结构

AccessKey

String

是

test

RocketMQ 密钥的 AccessKey。

Authority

String

是

Sub

RocketMQ 密钥对于当前 Topic 的访问权限。

• ALL：拥有发布、订阅权限
• PUB：拥有发布权限
• SUB：拥有订阅权限
• DENY：不具备发布或订阅权限

TopicName

String

是

my_topic

Topic 的名称。

Authority

String

是

Sub

RocketMQ 密钥对指定 Topic 的自定义权限：

• ALL：拥有发布和订阅权限
• PUB：拥有发布权限
• SUB：拥有订阅权限
• DENY：不具备发布或订阅权限

AllowListDesc

String

test

白名单描述。

AllowListIPNum

Integer

2

白名单中 IP 地址数量。

AllowListId

String

acl-90c721ca3f1648e7b980xxxxxx

白名单 ID。

AllowListName

String

test

白名单名称。

AllowListType

String

IPv4

白名单类型。目前仅支持 IPv4。

AssociatedInstanceNum

Integer

1

白名单已绑定的实例数量。

InstanceId

String

rocketmq-cnoexxxxx

RocketMQ 实例 ID。

InstanceName

String

test

RocketMQ 实例名称。

VPC

String

vpc-3ret6bva9k54wxxxxx

实例绑定的 VPC ID。

AccessKey

String

2QdEgrGc97AL1p38Fq13****

RocketMQ 密钥的 AccessKey ID。

AclConfigJson

String

{"topicPerms":{"RMQ_SYS_TRACE_TOPIC":"PUB","rocketmq123":"PUB

SUB"},"groupPerms":{"GID_test":"PUB

Actived

Boolean

true

RocketMQ 密钥的启用状态。

• true：启用
• false：未启用

AllAuthority

String

SUB

RocketMQ 密钥的默认权限。

• ALL：拥有发布、订阅权限
• PUB：拥有发布权限
• SUB：拥有订阅权限
• DENY：不具备发布或订阅权限

CreateTime

String

2022-11-04T07:12:56Z

RocketMQ 密钥的创建时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。

Description

String

test

RocketMQ 密钥的描述。

CreateTimestamp

Integer

1683784884

消息生成的时间戳，单位为秒。

IsExist

Bool

false

消息是否仍旧保留在服务端。

• true：消息存在。
• false：消息不存在。

MessageId

String

FDBD0FF1CE00003A0000000000000EFE425C18B4AAC23681EE4F0002

消息 ID。

MessageKey

String

FDBD0

消息 Key。为了避免特殊字符的影响，消息 Key 将会以 Base64 的编码的方式返回，需要通过 Base64 解码后才能查看。

MessageSize

Integer

47276

消息大小，单位为（Byte）。

ProducerHost

String

100.xx.xx.xx:xxxx

生产者实例地址。

ReconsumeTimes

Integer

1

消息重试消费的次数，即手动重发死信消息后，该消息再次进入死信队列的次数。

StoreTimestamp

Integer

1683784893

消息被服务端存储的时间戳，单位为秒。

Tag

String

FDBD0

消息 Tag。

GroupId

String

GID_test_group_id

消费组的 Group ID。

MessageModel

String

Clustering

消费模式。取值说明如下：

• Clustering：集群消费模式
• Broadcasting：广播消费模

SubString

String

订阅的规则，此字段直接透传消费组订阅此 Topic 时指定的字符串，一般为*或TAG1 || TAG2。

GroupId

String

GID_test_group_id

消费组的 Group ID。

Description

String

test

Group 的简单描述。

GroupType

String

TCP

Group 适用的协议。取值说明如下：

• TCP：此 Group ID 仅适用于 TTCP协议的消息收发。

AccountId

String

200000****

创建实例的火山引擎主账号ID。

ApplyPrivateDNSToPublic

Boolean

true

是否已开启公网解析功能。

• true：已开启
• false：已关闭

AvailableQueueNumber

Integer

3944

剩余可创建的分区数量。

ChargeDetail

ChargeDetailObject

实例的计费方式等计费信息。详细说明请参考【ChargeDetailObject】。

ComputeSpec

String

rocketmq.n1.x2.small

实例的计算规格。

CreateTime

String

2022-07-18T07:48:58Z

实例的创建时间。时间显示格式为YYYY-MM-DD'T'HH:MM:SS'Z'。

EipId

String

eip-mjhulvqza6805smt1bnc****

EIP 的 ID。
如果实例未开启公网访问方式，则不返回此参数。

EnableSSL

Boolean

false

实例是否已开启 SSL 认证。
开启实例的公网访问后，默认开启 SSL 认证。如果 SSLMode 设置为 permissive，则可以按需选择是否经由 SSL 认证。

FileReservedTime

Boolean

72

消息在消息队列 RocketMQ版服务端的保留时长，超过保留时长的消息将被过期清理。单位为小时。

InstanceDescription

String

这是一个测试实例

实例的简单描述。

InstanceId

String

rocketmq-cnai1f0c29ca****

实例 ID。

InstanceName

String

newnstance

实例名称。

InstanceStatus

String

Running

实例状态。

ProjectName

String

newproject

实例所属的 IAM 项目。如果实例不属于任何 IAM 项目，则不返回此参数。

RegionId

String

cn-shanghai

实例所在的地域 ID。

SSLMode

String

permissive

实例的公网连接策略，仅在开启公网访问时需要设置。支持设置为：

• enforcing：通过公网访问实例时，必须经由 SSL 认证。SSL 认证可实现数据的加密传输，相较于普通公网访问方式具备更高的安全性，但性能会有所下降。
• permissive：通过公网访问实例时，可以选择是否经由 SSL 认证。

StorageSpace

Integer

200

实例总存储空间。单位为 GiB。

StorageType

String

flexPL

实例的存储类型。即 flexPL或 pl0。

SubnetId

String

subnet-min6uy01kuf45smt1a2i****

VPC 的子网 ID。

Tags

Map<String, String>

{ "mode": "http", "tag-wzx": "11" }

已绑定的标签。

UsedGroupNumber

Integer

20

当前实例已经创建的消费组（Group）个数。

UsedStorageSpace

Integer

100

实例已用储空间。单位为 GiB。

UsedTopicNumber

Integer

20

当前实例已创建的 Topic 个数。

Version

String

4.8

支持的 RocketMQ 版本。当前支持的版本包括：

• 4.8：兼容 RocketMQ 4.x 版本系列

VpcId

String

vpc-13fo9gkz6j6683n6nu5ec****

私有网络（VPC） ID。

ZoneId

String

cn-guangzhou-a

实例所在的可用区 ID。对于跨 AZ 的高可用实例，此处会返回多个可用区 ID。

Body

String

aGVsbG8g&*****

消息体。您需要按照自己定义的序列化方式解析消息内容。

CreateTimestamp

Integer

1683313762

消息生成的时间戳，单位为秒。

IsExist

Bool

true

消息是否仍旧保留在服务端。

• true：消息存在。
• false：消息不存在。

MessageId

String

FDBDDC420003019700000000000000390017014AE5A51A6D2B75****

消息 ID。

MessageKey

String

FDBD

消息 Key。为了避免特殊字符的影响，消息 Key 将会以 Base64 的编码的方式返回，需要通过 Base64 解码后才能查看。

MessageSize

Integer

332

消息大小，单位为（Byte）。

ProducerHost

String

100.xx.xx.xx:612

生产者实例地址。

StoreTimestamp

Integer

1683313762

消息被服务端存储的时间戳，单位为秒。

Tag

String

FDBD

消息 Tag。

TopicName

String

test

Topic 名称。

EndOffset

Integer

1133024483

当前队列的最大偏移量，即下一条消息的偏移量，当前最新消息的位置为 EndOffset - 1。

LastUpdateTimestamp

Integer

1683546795534

该队列最近一次消息写入的时间。

MessageCount

Integer

95492440

当前队列队列内的消息个数。
EndOffset 为下一条消息的偏移量，所以 MessageCount=EndOffset-StartOffset。

QueueId

String

rocketmq-cnai81fd122a****-broker-0-0

队列的编号 ID。

StartOffset

Integer

1037532043

当前队列最早消息的偏移量。

CreateTime

String

2023-01-09T06:30:18Z

Topic 创建时间。

Description

String

test

Topic 描述。

MessageType

Integer

0

消息类型。取值说明如下：

• 0：普通消息
• 1：事务消息
• 2: 分区顺序消息
• 3: 全局顺序消息
• 4：延时消息

QueueNumber

Integer

10

队列个数。

TopicName

String

rocketmq123

Topic 名称。

ChargeType

String

PostPaid

实例的计费类型。支持的类型包括：

• PostPaid ：按量付费
• PrePaid：包年包月

ChargeStatus

String

Normal

实例的计费状态。包括：

• Normal：正常
• Overdue：按量计费欠费
• Expired：包年包月到期

AutoRenew

Boolean

true

包年包月实例到期后是否自动续费。

• true：自动续费。
• false：不自动续费。到期后需要手动续费，否则实例将被关停。

ChargeStartTime

String

2022-07-18T07:48:58Z

实例的开始计费时间。时间显示格式为YYYY-MM-DD'T'HH:MM:SS'Z'。

ChargeExpireTime

String

2022-07-18T07:48:58Z

包年包月实例的到期时间。时间显示格式为YYYY-MM-DD'T'HH:MM:SS'Z'。
按量付费实例此字段默认显示为 1970-01-01T00:00:00Z。

OverdueTime

String

2022-07-18T07:48:58Z

实例的欠费关停时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。

OverdueReclaimTime

String

2022-07-18T07:48:58Z

实例欠费关停后的预计释放时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。

PeriodUnit

String

Monthly

包年包月类型实例的生命周期单位，即指定以月或以年为单位购买。其中：

• Monthly：（默认）包月
• Yearly：包年

ChargeType

String

是

PostPaid

实例的计费类型。支持的类型包括：

• PostPaid ：按量付费
• PrePaid：包年包月

AutoRenew

Boolean

否

true

包年包月实例到期后是否自动续费。

• true：自动续费。
• false：（默认）不自动续费。到期后需要手动续费，否则实例将被关停。

仅包年包月类型的实例需要指定，即 ChargeType 指定为 PrePaid 时必选。

PeriodUnit

String

否

Monthly

包年包月类型实例的生命周期单位，即指定以月或以年为单位购买。支持设置为：

• Monthly：包月
• Yearly：包年

仅包年包月类型的实例需要指定，即 ChargeType 指定为 PrePaid 时必选。

Period

Integer

否

1

包年包月类型实例的购买时长。

• PeriodUnit 指定为 Monthly 时，取值范围为 1~9。
• PeriodUnit 指定为 Yearly 时，取值范围为 1~3。

仅包年包月类型的实例需要指定，即 ChargeType 指定为 PrePaid 时必选。

EndpointType

String

TCP

实例的接入点类型。

• TCP：TCP 协议接入点

NetworkType

String

PrivateNetwork

接入点的网络类型。统一为 PrivateNetwork。

InternalEndpoint

String

http://rocketmq-cnai1f0c29ca****.rocketmq.ivolces.com:9876

实例私网访问域名。

PublicEndpoint

String

http://rocketmq-cnai1f0c29ca****.rocketmq.volces.com:9876

实例公网访问域名。

ClientAddress

String

10.60.xxxx

该消费者实例的地址和端口。

ClientId

String

192.xxx.xx@16xxxx

该消费者实例的 ID。

Diff

Integer

10

消息堆积量。

Language

String

JAVA

消费者应用的开发语言。

Version

String

V4_8_0

消费端版本。

ConsumeOffset

Integer

300284750

当前消费进度。

DiffCount

Integer

0

未消费消息数。
EndOffset 为下一条消息的偏移量，所以 MessageCount=EndOffset-Consume Offset。

EndOffset

Integer

300284750

当前队列下一条消息的偏移量。
此参数定义为下一条消息的偏移量，则当前最新消息的位置为EndOffset - 1。

LastTimeStamp

Integer

0

队列最近一次消费行为的时间戳，单位秒级。

QueueId

String

rocketmq-cnai81fd122a****-broker-0-3

队列编号。

QueueNum

Integer

8

Topic 对应的队列数。每个 Topic 下有一到多个队列用于存储消息。

SubString

String

订阅规则。

TopicName

String

test

客户端订阅的 Topic 名称。

VpcID

String

是

vpc-8h1npd6fyry88k0t****

VPC ID。必须和已绑定的 VPC ID 一致。

SubnetID

String

是

subnet-min6uy01kuf45smt1a2i****

子网 ID。必须和已绑定的子网 ID 一致。

EipID

String

是

eip-mio5dafp42685smt1b37****

EIP ID。

Key

String

owner

标签的键。

Value

String

zhangsan

标签的值。

Key

String

owner

标签的键。

Value

String

zhangsan

标签的值。

InstanceId

String

rocketmq-cnai1f0c29ca****

实例 ID。

Key

String

key

实例标签的键。

Value

String

value

实例标签的值。

Permission

String

ALL

权限类型。

TopicName

String

TopicA

Topic 名称。

RegionId

String

cn-shanghai

地域 ID。

RegionName

String

cn-shanghai

地域名称。

Description

String

华东2（上海）

地域名称（中文）。

RegionStatus

String

Available

地域状态。

• Available：启用。用户可在此地域下进行查看、新建资源等动作
• Unavailable：停用。

您不可在停用的地域新开通服务，但不可新购此地域下的商品。已开通的服务依然提供支持，直至服务到期。

MessageId

String

消息 ID。

HasSucceed

Bool

false

该条死信消息重新发送是否成功。

• true：发送成功
• false：发送失败

ZoneId

String

cn-shanghai-a

可用区 ID。

ZoneName

String

cn-shanghai-a

可用区名称。

Description

String

可用区A

地域可用区中文名称。

Status

String

Normal

可用区的状态，包含以下状态：

• Normal：在售。
• Soldout：售罄。
• Unavailable：停用。

您不可在停用的可用区新开通服务，但不可新购此可用区下的商品。已开通的服务依然提供支持，直至服务到期。