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

数据结构

最近更新时间2023.11.10 16:08:12

首次发布时间2021.08.30 16:33:47

CreateInstanceInfo

实例创建时的相关信息。
被以下接口引用。

  • CreateInstance

参数

参数类型

示例值

说明

InstanceId

String

rbtmq-*******

实例 ID。

SubOrderId

String

预留参数,内容为空。

Endpoint

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

  • DescribeInstance

参数

参数类型

示例值

说明

EndpointType

String

AMQP0_9_1

接入点类型。

  • AMQP0_9_1:AMQP 协议的接入点。 您可以使用 AMQP 协议,通过此接入点访问RabbitMQ。
  • MQTT:MQTT协议的接入点。使用 MQTT 协议访问此地址之前,请先在控制台开启 rabbitmq_mqtt 和 rabbitmq_web_mqtt 插件。
  • WEB:RabbitMQ开源Web UI的访问地址。
  • WEB_MQTT:MQTT 协议(Web)的接入点。使用 MQTT 协议访问此地址之前,请先在控制台开启 rabbitmq_mqtt 和 rabbitmq_web_mqtt 插件。

Endpoint

String

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

接入点地址。

AccessType

String

Vpc

网络类型。
Vpc:私有网络 VPC 访问。

Instance

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

  • DescribeInstances

参数

参数类型

示例值

说明

InstanceId

String

rbtmq-*******

实例ID。

InstanceName

String

test-instance

实例名称。

InstanceStatus

String

Running

实例当前的状态。包括:

  • Creating:创建中
  • Running:运行中
  • TaskFailed:任务执行失败
  • WaitingPaid:等待支付
  • Released:已释放
  • Releasing:释放中

ComputeResource

String

rabbitmq.n1.x2.medium

实例的计算规格。

StorageType

String

CloudSSD

实例的存储类型。

StorageCapacity

Integer

1000

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

UsedStorage

Integer

100

实例已使用的存储空间,单位为GiB。

Version

RabbitMQVersion

RabbitMQ版本。详细信息请参考RabbitMQVersion

ArchType

String

Cluster

RabbitMQ实例类型。

  • SingleNode:单机版实例。
  • Cluster:集群版实例。

ChargeType

String

PrePaid

实例的计费类型。

  • PostPaid:按量计费。
  • PrePaid:包年包月。

PeriodUnit

String

Monthly

包年包月实例的购买时指定的时长单位。

  • Monthly:以月为单位购买。
  • Yearly:以年为单位购买。

OverdueTime

Integer

1645523741

包年包月实例到期时间,Unix时间戳格式。

CreatedTime

Integer

1645523741

实例的创建时间,Unix时间戳格式。

ChargeStatus

String

Normal

实例的计费状态。

  • Normal:正常收费中
  • Unpaid:待付款
  • Overdue:已过期
  • Expired:已释放
  • Reclaim:已回收

StopTime

Integer

1645523741

包年包月实例的预计关停时间,Unix 时间戳格式。

RecycleTime

Integer

1645523741

包年包月实例的预计回收时间,Unix 时间戳格式。

AutoReNew

Bool

true

是否自动续费。

  • true:自动续费
  • false:到期前需手动续费

Region

Region

实例地域。详细信息请参考 Region

Zone

Zone

实例的可用区。详细信息请参考 Zone

ProjectName

String

test-project

实例所在的 IAM Project 名称。

VpcId

String

test-vpc-id

VPC ID。

SubnetId

String

test-subnet-id

VPC子网 ID。

EipId

String

test-eip-id

弹性网卡 ID。

MaintainWindow

实例可维护的时间窗口。
被以下接口引用。

  • CreateInstance
  • DescribeInstance

参数

参数类型

是否可选

示例

说明

Day

String

可选

Monday

指定一周中的哪一天可以后台维护实例。

  • Monday:星期一。
  • Tuesday:星期二。
  • Wednesday:星期三。
  • Thursday:星期四。
  • Friday:星期五。
  • Saturday:星期六。
  • Sunday:星期日。

StartHour

Integer

可选

10

可维护周期的开始时间,StartHour 表示其小时部分。

StartMinute

Integer

可选

0

可维护周期的开始时间,StartMinute 表示其分钟部分。

EndHour

Integer

可选

23

可维护周期的结束时间,EndHour 表示其小时部分。

EndMinute

Integer

可选

0

可维护周期的结束时间,EndMinute 表示其分钟部分。

OperationEvent

后台任务的基本信息。
被以下接口引用。

  • DescribeOperationEvents

参数

参数类型

示例值

说明

OperationName

String

ModifyPlugin

后台任务名称。

EventSource

String

OpenAPI

后台任务来源。

  • WebConsole:通过控制台发起的任务。
  • OpenAPI:通过 OpenAPI 发起的任务。

StartTime

Integer

1645523741

后台任务开始执行的时间,Unix 时间戳格式。

Status

String

Executing

任务状态。

  • Success:执行成功
  • Failed:执行失败
  • Executing:执行中
  • Waiting:等待执行
  • Timeout:已超时

EndTime

Integer

1645523741

后台任务结束的时间,Unix 时间戳格式。

Duration

Integer

10

后台任务的总耗时,单位为秒。

OperationDetail

String

开启 rabbitmq_web_mqtt

任务详情说明。

InstanceId

String

rbtmq-*******

实例 ID。

OperationType

String

ModifyPlugin

任务类型。

  • ModifyPlugin:插件变更。
  • ScaleInstance:变更配置
  • RebootInstance:实例重启

EventID

String

1

任务 ID。

PluginDetail

所有插件的详细信息。
被以下接口引用。

  • DescribePlugins

参数

参数类型

示例值

说明

PluginName

String

rabbitmq_mqtt

插件名称。

Description

String

支持 MQTT 协议(TCP方式)

插件的描述信息。

Version

String

3.8.18

插件版本。

Enabled

Bool

true

是否开启插件。

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

NeedRebootOnChange

Bool

true

开启或关闭插件是否需要重启 RabbitMQ。

  • true:需要重启。
  • false:无需重启。

Port

Integer

5672

插件服务端口。

DisablePrompt

String

禁用该插件将触发 RabbitMQ 重启

关闭此插件的注意事项。

EnablePrompt

String

启用该插件将触发 RabbitMQ 重启

开启此插件的注意事项。

PluginStatus

待修改状态的插件列表。

说明

插件列表中未指定的插件,不调整其状态。

被以下接口引用。

  • 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 插件。

Enabled

Bool

必选

true

是否开启插件。

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

RabbitMQVersion

支持的 RabbiMQ 版本号。
被以下接口引用。

  • CreateInstance

参数

参数类型

示例值

说明

MajorVersion

Integer

3

Major 版本号。

MinorVersion

Integer

8

Minor 版本号。

PatchVersion

Integer

18

Patch 版本号。

Region

实例的地域信息。
被以下接口引用。

  • DescribeInstance

参数

参数类型

示例值

说明

Name

String

cn-beijing

地域名称。

Description

String

北京

地域描述信息。

Zone

实例的可用区信息。
被以下接口引用。

  • DescribeInstance

参数

参数类型

示例值

说明

Name

String

cn-beijing-a

可用区名称。

Description

String

北京

可用区描述信息。

IsSoldOut

Bool

false

实例资源是否已售罄。