文档中心

消息队列 RabbitMQ版

实例生命周期管理

CreateInstance - 创建实例

调用 CreateInstance 接口创建消息队列 RabbitMQ 版实例。

使用说明

实例是消息队列 RabbitMQ版服务的虚拟机资源。

说明

如果是首次创建 RabbitMQ 实例，您需要先完成跨服务访问授权，建议通过火山引擎主账号操作。详细说明请参考跨服务访问授权。

如果需要通过私有网络访问消息队列 RabbitMQ版实例，请先在相同地域创建 ECS 云服务器、私有网络和子网。创建实例后，不可更改实例所在的私有网络和子网。

如果需要通过公网访问消息队列 Kafka版实例，请先申请同地域的 EIP，详细操作步骤请参考申请公网IP。

默认情况下，您可以在每个地域中创建 5 个 RabbitMQ 实例。如需提高配额，请在配额中心申请提高每个地域下的最大实例数量（InstanceNum），最高可调整至 10 个。

注意事项

请求频率：该接口请求频率限制为 100 次/秒；单用户请求频率限制为 20 次/秒。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：CreateInstance

要执行的操作，取值：CreateInstance。

Version string 必选示例值：2022-01-01

API的版本，取值：2022-01-01。

ZoneId string 必选示例值：cn-beijing-a

实例所在的可用区 ID。

消息队列 RabbitMQ 版实例支持跨可用区部署，查看指定可用区下提供哪些计算规格时，可以指定多个可用区。多个可用区ID之间以逗号（,）间隔。

您可以调用 DescribeAvailabilityZones 接口查询当前提供服务的可用区列表。

UserName string 必选示例值：Test1

用户名称。需要满足以下要求：

由英文、数字、连字符（-）或下划线组成。

长度为 3~64 个字符。

ComputeSpec string 必选示例值：rabbitmq.n3.x2.medium

实例的计算规格。

消息队列 RabbitMQ版实例提供的计算规格清单，请参考产品规格。

Version string 必选示例值：3.8.18

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

3.8.18：RabbitMQ 3.8.18 版本。

3.12：RabbitMQ 3.12 版本。

UserPassword string 必选示例值：Test@123456

用户的密码。需要满足以下要求：

长度为 8~32 个字符。

由大写字母、小写字母、数字、特殊字符中的任意三种组成。

支持的特殊字符包括 !@#$%^&\*()\_+-=。

StorageSpace integer 必选示例值：1000

实例的存储空间。

单位为 GiB，必须指定为 100 的倍数。取值范围及默认值取决于当前指定的计算规格。

InstanceDescription string 可选示例值：instance for test

RabbitMQ 实例的简单描述。长度范围为 1~128 个字符。

VpcId string 必选示例值：vpc-13fo9gkz6j6683n6q****

实例所在的私有网络（VPC） ID。

说明

实例创建完成后，不可修改对应的私有网络和子网。创建实例时请谨慎操作。

您可以调用私有网络（VPC）的 DescribeVpcs 接口查询可用的 VPC 和子网列表。

ChargeInfo object 必选示例值：/

RabbitMQ 实例的计费类型等计费信息。

ChargeType string 必选示例值：PostPaid

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

PostPaid ：按量付费

PrePaid：包年包月

说明

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

AutoRenew boolean 可选示例值：false

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

true：自动续费。

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

说明

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

PeriodUnit string 可选示例值：Month

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

Month：包月

Year：包年

说明

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

Period integer 可选示例值：1

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

PeriodUnit指定为Month时，取值范围为 1~9。

PeriodUnit指定为Year时，取值范围为 1~3。

说明

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

SubnetId string 必选示例值：subnet-min6uy01kuf45sk****

实例所在的 VPC 子网 ID。

说明

实例创建完成后，不可修改对应的私有网络和子网。创建实例时请谨慎操作。

您可以调用私有网络（VPC）的 DescribeVpcs 接口查询可用的 VPC 和子网列表。

EipId string 可选示例值：eip-mjhulvqza6805smt****

EIP的ID。

说明

指定 EipId 表示开启实例的公网访问。

EIP 提供独立的公网 IP 资源，包括公网 IP 地址与公网出口带宽服务。指定此参数开启公网访问后，公网地址将绑定您的弹性公网 IP（EIP），费用由 EIP 收取。

InstanceName string 可选示例值：Name123

RabbitMQ 实例的名称。需满足以下要求：

只能包含中文、字母、数字、下划线（_）或连字符（-）。

不能以数字和连字符（-）开头。

长度范围为 1~128 个字符。

说明

如果创建实例时未指定名称，则默认将实例 ID 作为实例名称。

ClientToken string 必选示例值：123e4567-e89b-12d3-a456-42665544****

保证客户端请求幂等性的标识。

该标识为 1~64 位的 ASCII 字符串，大小写敏感，由客户端生成，应确保不同请求之间该标识具有唯一性。

如何使用幂等标识，请参考请求幂等性。

Tags object[] 可选示例值：/

云资源标签。可以将实例通过标签进行归类，便于实例的搜索和资源聚合。详细说明请参考标签管理。

Key string 必选示例值：owner

标签的键。

Value string 可选示例值：zhangsan

标签的值。

ProjectName string 可选示例值：newproject

当前创建的 RabbitMQ 实例所属的 IAM 项目。

说明

如果未指定 IAM 项目，消息队列 RabbitMQ版会将新实例添加到名为 default 的 IAM 项目中。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

InstanceId string 示例值：rbtmq-5b293870****

RabbitMQ 实例 ID。

OrderId string 示例值：order-712089661643355****

订单 ID。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	UnSupportedConfig	Unsupported instance configuration, please check.	配置不符合规范。
400	InvalidParameter	The specified parameter %s is not valid.	参数值%s无效。
400	InstanceCountExceedLimit	The number of instances exceeds the limit.	实例数量达到上限。
400	InsufficientBalance	Insufficient account balance.	余额不足。
403	OperationDenied.AccountNotAuthorized	You are not authorized to perform this operation.	您不具备相关权限，请授权或切换账号后重试。
500	InternalError	The request failed due to some unknown error, exception or failure.	内部错误，请稍后重试。
500	InsufficientResource	Insufficient resources, please switch to another available zone or region and try again.	资源不足，请稍后重试。

最近更新时间：2026.02.05 18:09:46

这个页面对您有帮助吗？

有用

无用