文档中心

CreateInstance

最近更新时间：2024.02.23 15:26:18

首次发布时间：2023.05.19 15:47:10

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

注意事项

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

使用说明

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

说明

如果是首次创建 RabbitMQ 实例，您需要先完成跨服务访问授权，建议通过火山引擎主账号操作。详细说明请参考跨服务访问授权。
如果需要通过私有网络访问消息队列 RabbitMQ版实例，请先在相同地域创建 ECS 云服务器、私有网络和子网。创建实例后，不可更改实例所在的私有网络和子网。
如果需要通过公网访问消息队列 RabbitMQ版实例，请先申请一个同地域的 EIP。详细操作步骤请参考申请公网IP。
默认情况下，您可以在每个地域中创建 5 个 RabbitMQ 实例。如需提高配额，请在配额中心申请提高每个地域下的最大实例数量（InstanceNum），最高可调整至 10 个。

请求参数

参数	参数类型	是否必选	示例值	说明
ZoneId	String	是	cn-beijing-a	实例所在的可用区 ID。消息队列 RabbitMQ版实例支持跨AZ部署，查看指定可用区下提供哪些计算规格时，可以指定多个可用区。多个可用区ID之间以逗号（,）间隔。您可以调用 DescribeAvailabilityZones 查询当前提供服务的可用区列表。
Version	String	是	3.8.18	支持的 RabbitMQ 版本。当前支持的版本包括： 3.8.18：RabbitMQ 3.8.18 版本。
ComputeSpec	String	是	rabbitmq.n3.x2.medium	实例的计算规格。消息队列 RabbitMQ版实例提供的计算规格清单，请参考产品规格。
StorageSpace	Integer	是	1000	实例的存储空间。单位为 GiB，必须指定为 100 的倍数。取值范围及默认值取决于当前指定的计算规格。
UserName	String	是	Test1	用户名称。需要满足以下要求：由英文、数字、连字符（-）或下划线组成。长度为 3~64 个字符。
UserPassword	String	是	Test@123456	用户的密码。需要满足以下要求：长度为 8~32 个字符。由大写字母、小写字母、数字、特殊字符中的任意三种组成。支持的特殊字符包括 `!@#$%^&*()_+-=`。
ChargeInfo	ChargeInfoObject	是		RabbitMQ 实例的计费类型等计费信息。详细信息请参考 ChargeInfoObject。
VpcId	String	是	vpc-13fo9gkz6j6683n6nu5ec****	实例所在的私有网络（VPC） ID。说明实例创建完成后，不可修改对应的私有网络和子网。创建实例时请谨慎操作。您可以调用私有网络（VPC）的 DescribeVpcs 接口查询可用的 VPC 和子网列表。
SubnetId	String	是	subnet-min6uy01kuf45smt1a2i****	实例所在的 VPC 子网 ID。说明实例创建完成后，不可修改对应的私有网络和子网。创建实例时请谨慎操作。您可以调用私有网络（VPC）的 DescribeVpcs 接口查询可用的 VPC 和子网列表。
EipId	String	否	eip-mjhulvqza6805smt1bnc****	EIP的ID。说明指定 EipId 表示开启实例的公网访问。 EIP 提供独立的公网IP资源，包括公网 IP 地址与公网出口带宽服务。指定此参数开启公网访问后，公网地址将绑定您的弹性公网 IP（EIP），费用由 EIP 收取。
InstanceName	String	否	Name123	RabbitMQ 实例的名称。需满足以下要求：只能包含中文、字母、数字、下划线（_）和连字符（-）。不能以数字和连字符（-）开头。长度范围为 1~128 个字符。说明如果创建实例时未指定名称，则默认将实例 ID 作为实例名称。
InstanceDescription	String	否	instance for test	RabbitMQ 实例的简单描述。长度范围为 1~128 个字符。
ProjectName	String	否	newproject	当前创建的 RabbitMQ 实例所属的 IAM 项目。说明如果未指定 IAM 项目，消息队列 RabbitMQ版会将新实例添加到名为 `default` 的 IAM 项目中。
TagMap	MapString	否	{"testKey":"testVal"}	云资源标签。可以将实例通过标签进行归类，便于实例的搜索和资源聚合。详细说明请参考标签管理。
ClientToken	String	否	123e4567-e89b-12d3-a456-426655440000	保证客户端请求幂等性的标识。该标识为 1~64 位的 ASCII 字符串，大小写敏感，由客户端生成，应确保不同请求之间该标识具有唯一性。如何使用幂等标识，请参考请求幂等性。

响应参数

参数	参数类型	示例值	说明
InstanceId	String	rbtmq-5b293870****	RabbitMQ 实例 ID。
OrderId	String	order-712089661643355****	订单 ID。

示例

请求示例

POST https://rabbitmq.volcengineapi.com/?Action=DescribeComputeSpecsInfo&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rabbitmq.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/rabbitmq/request, SignedHeaders=x-date, Signature=********

{
   "ZoneId": "cn-guangzhou-a",
   "Version": "3.8.18",
   "ComputeSpec": "rabbitmq.n3.x2.medium",
   "StorageSpace": 1000,
   "UserName": "Admin",
   "UserPassword": "Admin-123",
   "ChargeInfo": {
       "ChargeType":"PostPaid"
   },
   "VpcId":"vpc-3ezqp84nkhlvk72200sck****",
   "SubnetId": "subnet-3ezqp8sbxu9kw72200smp****"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "202302211942179576CA8B35BEC3E94AB6",
        "Action": "CreateInstance",
        "Version": "2022-01-01",
        "Service": "RabbitMQ",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "InstanceId": "rbtmq-7585af44****",
        "OrderId": "Order720257278320081****"
    }
}

注意事项

使用说明

请求参数

响应参数

示例

请求示例

响应示例