You need to enable JavaScript to run this app.
导航

数据结构

最近更新时间2023.12.14 17:14:26

首次发布时间2023.05.19 15:47:09

BasicInstanceInfoObject

实例的基本信息,包括实例名称、ID 等信息。
被以下接口引用:

  • DescribeInstances
  • DescribeInstanceDetail

名称

类型

示例值

描述

ApplyPrivateDNSToPublic

bool

false

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

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

ArchType

String

Cluster

实例的类型,即集群版或单机版。

  • SingleNode:单机版
  • Cluster:集群版

ChargeDetail

ChargeDetailObject

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

ComputeSpec

String

rabbitmq.n3.x2.medium

RabbitMQ 实例的计算规格。

CreateTime

String

1654485759

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

EipId

String

eip-mjhulvqza6805smt1bnc****

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

InitUserName

String

Admin

RabbitMQ WebUI 管理员账号名。

InstanceDescription

String

这是一个测试实例

实例的简单描述。

InstanceId

String

rabbitmq-cnngqkfgdudt****

RabbitMQ 实例 ID。

InstanceName

String

RabbitMQinstance

RabbitMQ 实例名称。

InstanceStatus

String

Running

实例状态。

IsEncrypted

bool

false

是否开启了云盘加密。

  • 云盘加密为邀测功能,如需使用,请联系技术支持申请白名单。
  • 仅 DescribeInstanceDetail 接口返回此字段。

ProjectName

String

newproject

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

RegionDescription

String

华南1(广州)

地域的描述信息。

RegionId

String

cn-guangzhou

实例所在的地域 ID。

StorageSpace

Integer

200

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

SubnetId

String

subnet-min6uy01kuf45smt1a2i****

VPC 的子网 ID。

TagMap

map<String,String>

{
"project": "lisa"
}

已绑定的标签。

UsedStorageSpace

Integer

100

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

Version

String

3.8.18

支持的 RabbitMQ 版本。当前支持的版本包括:

  • 3.8.18:RabbitMQ 3.8.18 版本。

VpcId

String

vpc-13fo9gkz6j6683n6nu5ec****

私有网络(VPC) ID。

ZoneDescription

String

华南1(广州)-可用区B

可用区的描述信息

ZoneId

String

cn-guangzhou-a

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

AccountId

String

2000****

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

BasicPluginInfoObject

该实例的插件信息,包括支持的插件列表、每个插件的开启状态等。
被以下接口引用:

  • DescribePlugins

名称

类型

示例值

描述

Description

String

支持 MQTT 协议(TCP方式)

插件的描述信息。

DisablePrompt

String

禁用该插件将触发RabbitMQ集群滚动重启

关闭此插件的注意事项说明。

EnablePrompt

String

启用该插件将触发RabbitMQ集群滚动重启

开启此插件的注意事项说明。

Enabled

Bool

true

是否已开启插件。

  • true:插件已开启。
  • false:插件已关闭。

NeedRebootOnChange

Bool

true

开启或关闭插件是否会引发 RabbitMQ 实例重启。

  • true:会重启实例。
  • false:不会重启实例。

PluginName

String

rabbitmq_mqtt

插件名称。

Port

Integer

8883

插件的服务端口。

Version

String

3.8.18

插件版本。

ChargeDetailObject

实例的计费信息,包括计费方式等信息。
被以下接口引用:

  • DescribeInstances
  • DescribeInstanceDetail

名称

类型

示例值

描述

ChargeType

String

PostPaid

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

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

ChargeStatus

String

Normal

实例的计费状态。包括:

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

ChargeStartTime

String

2022-01-02T15:04:05Z07:00

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

ChargeEndTime

String

2022-01-02T15:04:05Z07:00

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

AutoRenew

Bool

true

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

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

ChargeExpireTime

String

2022-01-02T15:04:05Z07:00

包年包月实例的到期时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
仅包年包月实例返回此参数。

OverdueTime

String

2022-01-02T15:04:05Z07:00

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

OverdueReclaimTime

String

2022-01-02T15:04:05Z07:00

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

ChargeInfoObject

RabbitMQ实例的计费类型等计费信息。
被以下接口引用:

  • CreateInstance
  • ModifyInstanceChargeType

名称

类型

是否必选

示例值

描述

ChargeType

String

PostPaid

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

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

指定为 PrePaid 时,应同时指定 AutoRenew、PeriodUnit 和 Period 参数。

AutoRenew

Bool

true

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

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

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

PeriodUnit

String

Month

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

  • Month:包月
  • Year:包年

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

Period

Integer

1

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

  • PeriodUnit 指定为 Month 时,取值范围为 1~9。
  • PeriodUnit 指定为 Year 时,取值范围为 1~3。

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

ComputeSpecsInfoObject

计算规格列表,其中包括每个计算规格的规格详情。关于各个计算规格的详细说明,请参考产品规格
被以下接口引用:

  • DescribeComputeSpecsInfo

名称

类型

示例值

描述

ArchType

实例类型

Cluster

实例的类型,即集群版或单机版。

  • SingleNode:单机版
  • Cluster:集群版

ComputeSpec

String

rabbitmq.n3.x2.medium

RabbitMQ 实例的计算规格。

ConnectionNumber

Integer

9000

连接数上限。

QueueNumber

Integer

600

队列数上限。

SpecStatus

String

Normal

当前计算规格在指定可用区的售卖状态。包括:

  • Normal:售卖中。该规格在指定可用区正在售卖中。
  • Unsupported:暂不支持该规格。指定可用区暂不支持购买此规格的实例。
  • Soldout:已售罄。该规格在指定可用区已售罄。

StorageSpaceMax

Integer

12000

可配置的磁盘容量上限,单位为 GiB。

StorageSpaceMin

Integer

300

可配置的磁盘容量下限,单位为 GiB。

TPS

Integer

45000

读+写流量峰值。

EndpointObject

实例的接入点列表。
被以下接口引用:

  • DescribeInstanceDetail

名称

类型

示例值

描述

EndpointType

String

WEB

实例的接入点类型。关于接入点的详细说明请参考【查看接入点】。
RabbitMQ实例提供的接入点类型包括:

  • WEB:Web UI 接入点
  • AMQP0_9_1:AMQP 接入点
  • MQTT:MQTT接入点
  • WEB_MQTT:WEB MQTT 接入点
  • STOMP:STOMP 接入点

InternalEndpoint

String

rbtmq-322db6ab****.rabbitmq.ivolces.com:5672

实例的私网访问域名。

NetworkType

String

PrivateNetwork

接入点的网络类型。PrivateNetwork 表示私有网络 VPC。

PublicEndpoint

String

rbtmq-322db6ab****.rabbitmq.volces.com:5671

实例公网访问域名。仅在开启公网访问之后显示。

PluginsList

待修改启用状态的插件列表。
被以下接口引用:

  • ModifyPlugin

名称

类型

是否必选

示例值

描述

PluginName

String

必选

rabbitmq_mqtt

插件名称。支持设置为:

  • rabbitmq_mqtt:表示实例是否支持 MQTT 协议(TCP方式)。
  • rabbitmq_web_mqtt:表示实例是否支持 MQTT 协议(WebSocket方式)。
  • rabbitmq_delayed_message_exchange:表示实例是否开启消息延迟功能。插件延迟时间存在 1% 左右的误差,可能提前或者推迟发送消息给消费者。
  • rabbitmq_stomp:表示实例是否支持 STOMP 协议。
  • rabbitmq_tracing:表示是否开启 tracing 插件。
  • rabbitmq_consistent_hash_exchange:表示是否开启一致性哈希交换机。

Enabled

Bool

必选

true

是否开启插件。

  • true:开启插件。
  • false:(默认)关闭插件。

RegionObject

地域列表。
被以下接口引用:

  • DescribeRegions

名称

类型

是否必选

示例值

描述

RegionId

String

cn-shanghai

地域 ID。

RegionName

String

cn-shanghai

地域名称。

Description

String

华东2(上海)

地域名称(中文)。

Status

String

Available

地域状态。

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

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

TagFilterObject

标签详情,用于筛选含有此标签的实例。
被以下接口引用:

  • DescribeTagsByResource

名称

类型

示例值

描述

Key

String

owner

标签的键。

Value

String

zhangsan

标签的值。

TagObject

标签详情。
被以下接口引用:

  • AddTagsToResource

名称

类型

示例值

描述

Key

String

owner

标签的键。

Value

String

zhangsan

标签的值。

TagResource

标签详情。
被以下接口引用:

  • AddTagsToResource

名称

类型

示例值

描述

Key

String

owner

标签的键。

Value

String

zhangsan

标签的值。

InstanceId

String

rbtmq-xxx

实例 ID。

ZoneObject

被以下接口引用:

  • DescribeAvailabilityZones

名称

类型

示例值

描述

ZoneId

String

cn-beijing-a

可用区 ID。

ZoneName

String

cn-beijing-a

可用区名称。

Description

String

可用区A

地域可用区中文名称。

Status

String

Normal

可用区的状态,包含以下状态:

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

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