文档中心

CreateInstance

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

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

调用 CreateInstance 接口创建 RabbitMQ 实例。

注意事项

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

使用说明

使用消息队列 RabbitMQ版服务之前，请先通过 CreateInstance 接口创建 RabbitMQ 实例。

说明

通过 API 创建接口时暂不支持同时开启公网访问功能，如果需要开启实例的公网访问，建议在创建实例完成后，实例状态为运行中（Running）时，调用 CreateInstancePublicAccess 开启实例的公网访问。
默认情况下，您可以在每个地域中创建 5 个 RabbitMQ 实例，否则创建实例时报错 The Instance has exceeded quota。如需提高配额，请在配额中心提交申请，例如提高每个地域下的最大实例数量（InstanceNum），最高可调整至 10 个。

请求参数

参数	参数类型	是否必选	示例值	说明
InstanceName	String	必选	test-instance	RabbitMQ 实例名称。需满足以下要求：只能包含中文、英文字母、数字、下划线（_）和连字符（-）。不能以数字或连字符（-）开头。长度为 0～128 字符。未设置 RabbitMQ 实例名称时，将用实例ID作为实例名称。
Description	String	必选	description of test instance	实例的描述信息。
Region	String	必选	cn-beijing	实例所在的地域。
Zone	String	必选	cn-beijing-a	实例所在的可用区。消息队列 RabbitMQ版支持多可用区部署 RabbitMQ 实例，对于 3 个及以上可用区的地域，您可以通过指定 3 个可用区的方式实现跨可用区部署。多个可用区之间通过英文逗号（,）分隔。例如cn-guangzhou-a,cn-guangzhou-b。
Version	RabbitMQVersion	必选		RabbitMQ 版本，详细信息请参考 RabbitMQVersion。目前仅支持 3.8.18 版本。
ComputeResource	String	必选	rabbitmq.n1.x2.medium	计算规格。支持设置为： rabbitmq.n1.x2.medium rabbitmq.n3.x2.medium rabbitmq.n5.x2.medium rabbitmq.n7.x2.medium 其中，rabbitmq.n1.x2.medium 为单机版实例，仅部署一个 RabbitMQ 代理。
StorageType	String	必选	CloudSSD	存储类型。支持设置为： CloudSSD：SSD 云盘。
StorageCapacity	Integer	必选	1000	实例存储空间，单位为 GiB。
ChargeType	String	必选	PrePaid	实例的计费类型。支持设置为： PostPaid：按量计费。 PrePaid：包年包月。指定包年包月模式时，需要通过 ChargeSubType 和 ChargeUnitNum 指定购买时长，并通过 AutoReNew 参数指定是否自动续费。
ChargeSubType	String	可选	Monthly	包年包月实例购买的时长单位。支持设置为： Monthly：以月为单位购买。 Yearly：以年为单位购买。
MaintainWindow	MaintainWindow	必选		实例的可维护时间窗。详细信息请参考 MaintainWindow。
NetTypes	List	必选	[ "Vpc" ],	实例的网络类型。支持的值为 `Vpc`，即私有网络 VPC 访问。设置开启 VPC 访问时，您需要通过 VpcId 和 SubnetId 指定实例对应的 VPC 和子网。如果需要开启公网访问，在创建实例之后调用 CreateInstancePublicAccess 接口开启公网访问并绑定公网 IP 地址。
VpcId	String	必选	test-vpc-id	VPC ID。
SubnetId	String	必选	test-subnet-id	VPC 子网 ID。
UserName	String	必选	Admin	管理员的用户名称。须满足以下要求：长度范围为 3~64 个字符。只能包含英文、数字、短横线（-）和下划线（_）。
Password	String	必选	AdminPassword	管理员用户密码。须满足以下要求： 8~32 个字符。包含大写字母、小写字母、数字、特殊字符中的三种。特殊字符包括!@#$%^&*()_+-=
ChargeUnitNum	Integer	可选	1	购买的时长数量。仅在计费类型为包年包月时有效，即 ChargeType 指定为 PrePaid。以月为单位购买时，最多购买 11 个月。以年为单位购买时，最多购买 3 年。
AutoReNew	Bool	可选	true	是否自动续费，包年包月必传。
ProjectName	String	可选	test-project	实例所属的 IAM 项目。默认情况下，消息队列 RabbitMQ版不会将实例添加到任何 IAM 项目中。

响应参数

参数	参数类型	说明
Instances	JSON Array	实例 ID。详细信息请参参。
OrderId	String	订单 ID。

参数	参数类型	说明
Instances	JSON Array	实例 ID。详细信息请参考CreateInstanceInfo。
OrderId	String	订单 ID。

示例

请求示例

POST https://rabbitmq.volcengineapi.com/?Action=CreateInstance&Version=2018-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=********

{
  "InstanceName": "test-instance",
  "Description": "description of test instance",
  "Region": "cn-beijing",
  "Version": {
    "MajorVersion": 3,
    "MinorVersion": 8,
    "PatchVersion": 18
  },
  "ComputeResource": "rabbitmq.n1.x2.medium",
  "StorageType": "CloudSSD",
  "StorageCapacity": 1000,
  "ChargeType": "PrePaid",
  "ChargeSubType": "Monthly",
  "ChargeUnitNum": 1,
  "MaintainWindow": {
    "Day": "Monday",
    "StartHour": 10,
    "StartMinute": 0,
    "EndHour": 23,
    "EndMinute": 0
  },
  "AutoReNew": true,
  "NetTypes": [
    "Vpc"
  ],
  "ProjectName": "test-project",
  "SubnetId": "test-subnet-id",
  "VpcId": "test-vpc-id",
  "Zone": "cn-beijing-a"
}

响应示例

{
  "ResponseMetadata": {
    "RequestId": "********",
    "Action": "CreateInstance",
    "Version": "2018-01-01",
    "Service": "rabbitmq",
    "Region": "cn-beijing"
  },
  "Result": {
    "Instances": [
      {
        "InstanceId": "rbtmq-*******",
        "SubOrderId": ""
      }
    ],
    "OrderId": "example-order-id"
  }
}