数据结构--消息队列 RocketMQ版-火山引擎

文档中心

导航

数据结构

最近更新时间：2023.07.12 16:47:04首次发布时间：2021.08.30 19:04:35

AccessPoint

实例的接入点信息。
被以下接口引用。

GetInstance
ListInstances

参数	参数类型	示例值	说明
Endpoint	String	b****	接入地址（Endpoint）。
Network	String	Private	网络类型。 Public：公网访问。 Private：VPC 访问。
NetworkType	String	Exclusive	详细网络类型。 Exclusive：VPC 专享实例。 PublicNetWork：公网访问。
Protocol	String	TCP	协议类型。

AuthKeyPermission

RocketMQ 密钥的自定义权限。
被以下接口引用：

ListTopicPermissions

参数	参数类型	示例值	说明
Ak	String	ak*******	RocketMQ 密钥中的 AccessKey ID。
Permission	String	DENY	当前密钥对于此 Topic 的自定义权限。 DENY：不具备发布或订阅权限。 PUB：仅具备发布权限，不具备订阅权限。 SUB：仅具备订阅权限，不具备发布权限。 ALL：同时具备发布和订阅权限。

参数

参数类型

示例值

说明

String

ak*******

RocketMQ 密钥中的 AccessKey ID。

Permission

String

DENY

当前密钥对于此 Topic 的自定义权限。

DENY：不具备发布或订阅权限。
PUB：仅具备发布权限，不具备订阅权限。
SUB：仅具备订阅权限，不具备发布权限。
ALL：同时具备发布和订阅权限。

ComputeConfig

实例的计算规格。
被以下接口引用。

CreateInstance
GetInstance
ListInstances
ScaleInstance

参数	参数类型	是否必选	示例值	说明
NormType	String	必选	rocketmq.n1.x2.medium	计算规格。支持设置为： rocketmq.n1.x2.medium rocketmq.n2.x2.medium rocketmq.n3.x2.medium

参数

参数类型

是否必选

示例值

说明

NormType

String

必选

rocketmq.n1.x2.medium

计算规格。支持设置为：

rocketmq.n1.x2.medium
rocketmq.n2.x2.medium
rocketmq.n3.x2.medium

DiskUsage

磁盘容量信息。
被以下接口引用。

GetInstance
ListInstances

参数	参数类型	示例值	说明
Used	Integer	500	已用容量，单位为 GiB。
Total	Integer	1000	已购买的总容量，单位为 GiB。

ExportMessage

导出的死信消息内容。
被以下接口引用：

ExportDLQMessages

参数	参数类型	示例值	说明
Value	JSON Array	10.1..	字段的内容。
msgNotExist	Bool	true	消息是否仍旧保存在服务端。 true：因超出服务端保存时长，此消息已被删除。 false：消息仍旧保存在服务端。
shouldRetryQuery	Bool	false	是否需要重试查询。 true：重试。 false：不重试。

参数

参数类型

示例值

说明

Value

JSON Array

10.1..

字段的内容。

msgNotExist

Bool

true

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

true：因超出服务端保存时长，此消息已被删除。
false：消息仍旧保存在服务端。

shouldRetryQuery

Bool

false

是否需要重试查询。

true：重试。
false：不重试。

GroupInfo

Group的概述信息。
被以下接口引用：

ListGroups

参数	参数类型	示例值	说明
InstanceId	String	MQ_INST_********	实例ID。
GroupID	String	newgroup	Group 名称。
Protol	String	TCP	协议类型。目前仅支持 TCP。
Description	String	newgroup	消费组的简单描述。
CreatedTime	Integer	1649432780	Group 的创建时间。

GroupDetail

Group 的详细信息。
被以下接口引用：

GetGroup

参数	参数类型	示例值	说明
InstanceId	String	MQ_INST_********	实例 ID。
GroupID	String	newtopic	Group 名称。
Description	String	事务消息 Topic	Group 的简单描述信息。
Protol	string	TCP	协议类型。目前仅支持 TCP。
CreatedTime	Integer	1649432780	Group 的创建时间。
Tags	String List		Group的标签。预留字段，置空。
InstanceName	String	rocketmq	实例名称。
InstanceType	String	Exclusive	Group 所在实例的类型。
InstanceRegion	String	cn-beijing	实例所在地域。

InstanceDetail

实例的详细信息。
被以下接口引用。

GetInstance

参数	参数类型	示例值	说明
InstanceName	String	newinstance	实例名称。
InstanceId	String	MQ_INST_********	实例 ID。
Description	String	newinstance	实例的描述信息。
TopicCount	Integer	0	已创建的 Topic 数量。
GroupCount	Integer	0	已创建的 Group 数量。
CreateTime	Integer	1649330788	实例的创建时间。Unix 时间戳格式。
Tags	String		预留字段，默认为空值。
TcpAccessPoint	JSON Array		TCP 接入点相关信息。详细信息请查看AccessPoint。
HttpAccessPoint	JSON Array		预留字段，默认为空。
VpcNetwork	String	Exclusive	VPC网络类型，仅支持 Exclusive。
VpcId	String	vpc-3c*******	实例所在的的 VPC ID。
AkSkCount	Integer	2	该实例中的 RocketMQ 密钥数量。
Status	String	Creating	实例当前的状态。包括： Creating：创建中 Running：运行中 TaskFailed：任务执行失败 WaitingPaid：等待支付 Released：已释放 Releasing：释放中 NetCreating：申请公网中 NetReleasing：释放公网中
RocketMQVersion	String	4.8	RocketMQ 版本。目前仅支持 4.8 版本。
ComputeResource	ComputeConfig		计算规格。详细说明请参考 ComputeConfig。
StorageResource	StorageConfig		存储规格。详细说明请参考 StorageConfig。
DiskUsage	DiskUsage		磁盘用量。详细说明请参考 DiskUsage。
Zone	Zone		地域与可用区信息。详细说明请参考 Zone。
VpcName	String	vpc****	实例所在 VPC 名称。
ChargeType	String	PostPaid	实例的计费类型。 PostPaid：按量计费。 PrePaid：包年包月。
ChargeSubType	String	Monthly	对于包年包月实例，需要指定购买的时长单位。Monthly 表示以月为单位购买。
ChargeStatus	String	Normal	计费状态。 Normal：正常收费中 Unpaid：待付款 Overdue：已过期 Expired：已释放 Reclaim：已回收
AutoReNew	Bool	true	是否自动续费。 true：自动续费 false：到期前需手动续费
StopTime	Integer	1649330788	包年包月实例到期时间。Unix 时间戳格式。
OverdueTime	Integer	1649330788	预计过期关停的时间。
RecycleTime	Integer	1649330788	预计实例被回收的时间。
ProjectName	String	new	实例所在的 IAM Project 名称。
SubnetID	String	32**	VPC 子网 ID。
Type	String	Exclusive	实例类型。Exclusive 表示专享实例。
Nets	JSON Array	Exclusive	公网访问信息，仅在开启公网访问后返回。详细信息请参考 PublicNet。
FileReservedTime	Integer	168	消息在消息队列 RocketMQ版服务端的保留时长，超过保留时长的消息将被过期清理。

InstanceInfo

RocketMQ 实例的详细信息。
被以下接口引用。

ListInstances

参数	参数类型	示例值	说明
InstanceName	String	newinstance	实例名称。
InstanceId	String	MQ_INST_********	实例ID。
Description	String	newinstance	实例的描述信息。
Status	String	Running	实例当前的状态。包括： Creating：创建中 Running：运行中 TaskFailed：任务执行失败 WaitingPaid：等待支付 Released：已释放 Releasing：释放中 NetCreating：申请公网中 NetReleasing：释放公网中
TopicCount	Integer	2	已创建的 Topic 数量。
GroupCount	Integer	2	已创建的 Group 数量。
CreateTime	Integer	1648540332	实例的创建时间。
AkSkCount	Integer	2	该实例中的 RocketMQ 密钥数量。
VpcId	String	vpc-***	实例所在的 VPC ID。
RocketMQVersion	String	4.8	RocketMQ 版本。目前仅支持 4.8 版本。
ComputeResource	ComputeConfig		计算规格。详细说明请参考 ComputeConfig。
StorageResource	StorageConfig		存储规格。详细说明请参考 StorageConfig。
DiskUsage	DiskUsage		磁盘用量。详细说明请参考 DiskUsage。
Zone	Zone		地域与可用区信息。详细说明请参考 Zone。
VpcName	String	vpc****	实例所在VPC名称。
ChargeType	String	PostPaid	实例的计费类型。 PostPaid：按量计费。 PrePaid：包年包月。
ChargeSubType	String	Monthly	对于包年包月实例，需要指定购买的时长单位。Monthly表示以月为单位购买。
ChargeStatus	String	Normal	计费状态。 Normal：正常收费中 Unpaid：待付款 Overdue：已过期 Expired：已释放 Reclaim：已回收
AutoReNew	Bool	true	是否自动续费。 true：自动续费 false：到期前需手动续费
StopTime	Integer	1649330788	包年包月实例到期时间。Unix 时间戳格式。
OverdueTime	Integer	1649330788	预计过期关停的时间。
RecycleTime	Integer	1649330788	预计实例被回收的时间。
ProjectName	String	new	实例所在的 IAM Project 名称。
SubnetID	String	32**	VPC子网ID。
Type	String	Exclusive	实例类型。Exclusive 表示专享实例。

Message

死信消息相关信息。
被以下接口引用：

QueryDLQMessageByMessageId

参数	参数类型	说明
MsgId	String	消息ID，即 MessageID。
ProducerIP	String	消息生产的地址。
MessageSize	Integer	消息大小，单位为 MiB。
Tags	String	消息标签。
MessageKeys	String	消息 Key。
BornTimestamp	Integer	消息生产时间。
StoreTimestamp	Integer	消息在服务端存储的时间。
Properties	Map<String,String>	消息属性。
Body	String	消息体，base64 编码。
Topic	String	消息所在的 Topic 名称。
ReconsumeTimes	Integer	重复消费次数，一般在死信队列中展示这个字段。
InstanceId	String	实例 ID。
BodyCRC	Integer	消息体 CRC。

PublicNet

公网访问信息。
被以下接口引用：

GetInstance
EnablePublicNetwork

参数	参数类型	说明
NetworkType	String	网络类型。 PublicNetWork：已开启公网访问。
VpcID	String	VPC ID。
SubnetID	String	子网 ID。
EipIDs	List	EIP ID。
Status	String	公网状态。 Creating：创建中。 Running：运行中。 Releasing：释放中。 NeedScale：需扩容。

StorageConfig

实例的存储规格。
被以下接口引用。

CreateInstance
GetInstance
ListInstances
ScaleInstance

参数	参数类型	是否必选	示例值	说明
NormType	String	必选		存储类型，该参数请传空值。
Value	Integer	必选	600	存储空间大小，单位为 GiB。存储空间的取值范围取决于实例的计算规格，请参考实例规格设置正确的存储空间大小。

TopicDetail

Topic 详细信息。
被以下接口引用：

GetTopic

参数	参数类型	示例值	说明
InstanceId	String	MQ_INST_********	实例ID。
InstanceName	String	myinstance	实例名称。
InstanceRegion	String	cn-beijing	实例所在地域。
InstanceType	String	normal	实例类型。
TopicName	String	newtopic	Topic 名称。
Description	String	事务消息Topic	Topic 的简单描述信息。
MessageType	String	Common	消息类型。支持设置为： Common：普通消息。 Transtaction：事务消息。 PartationOrdered：分区顺序消息。 GolbalOrdered：全局顺序消息。 Timed：延时消息。
CreatedTime	Integer	1649330788	Topic 的创建时间。Unix 时间戳格式。
Tags	List		Topic 的标签。预留字段，置空。

TopicInfo

Topic 基本信息。
被以下接口引用：

ListTopics

参数	参数类型	示例值	说明
InstanceId	String	MQ_INST_********	实例 ID。
TopicName	String	newtopic	Topic 名称。
Description	String	事务消息Topic	Topic 的简单描述信息。
MessageType	String	Common	消息类型。支持设置为： Common：普通消息。 Transtaction：事务消息。 PartationOrdered：分区顺序消息。 GolbalOrdered：全局顺序消息。 Timed：延时消息。
CreatedTime	Integer	1649330788	Topic 的创建时间。Unix 时间戳格式。
Tags	List		Topic 的标签。预留字段，置空。

TopicPermission

RocketMQ 密钥的自定义权限。
被以下接口引用：

DescribeAuthKey

参数	参数类型	示例值	说明
Topic	String	newtopic	使用自定义权限的 Topic。
Permission	String	DENY	当前密钥对于此 Topic 的自定义权限。 DENY：不具备发布或订阅权限。 PUB：仅具备发布权限，不具备订阅权限。 SUB：仅具备订阅权限，不具备发布权限。 ALL：同时具备发布和订阅权限。

参数

参数类型

示例值

说明

Topic

String

newtopic

使用自定义权限的 Topic。

Permission

String

DENY

当前密钥对于此 Topic 的自定义权限。

DENY：不具备发布或订阅权限。
PUB：仅具备发布权限，不具备订阅权限。
SUB：仅具备订阅权限，不具备发布权限。
ALL：同时具备发布和订阅权限。

Zone

地域与可用区信息。
被以下接口引用。

GetInstance
ListInstances

参数	参数类型	示例值	说明
Name	String	cn-beijing-a	可用区。
Description	String	可用区a	可用区描述。