You need to enable JavaScript to run this app.
导航
消息队列 RocketMQ版
  • 文档首页
    • /消息队列 RocketMQ版/API 参考/V2（2023-01-01）/实例管理/CreateInstance - 创建实例
CreateInstance - 创建实例
最近更新时间：2024.11.18 10:27:30首次发布时间：2023.07.12 16:22:34
我的收藏

调用 CreateInstance 接口创建 RocketMQ 实例。

使用说明

实例是消息队列 RocketMQ 版的基本服务单位，用以管理和存储 Topic、Group 资源。

  • 如果是首次创建 RocketMQ 实例，您需要先完成跨服务访问授权，建议通过火山引擎主账号操作。详细说明请参考跨服务访问授权。
  • 如果需要通过私有网络访问消息队列 RocketMQ版实例，请先在相同地域创建 ECS 云服务器、私有网络和子网。创建实例后，不可更改实例所在的私有网络和子网。
  • 如果需要通过公网访问消息队列 RocketMQ版实例，请先申请同地域的 EIP，建议该 EIP 的带宽上限大于预估的公网业务流量峰值。详细操作步骤请参考申请公网 IP。
  • 默认情况下，您可以在每个地域中创建 5 个 RocketMQ 实例，且每个账号在每个地域中的所有实例存储容量总和最大为 10TiB，否则创建实例时报错The InstanceNum/StorageSum has exceeded quota。如需提高配额，请在配额中心提交申请，例如提高每个地域下的最大实例数量（InstanceNum），最高可调整至 10 个。

注意事项

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

调试

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

请求参数

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

参数
类型
是否必填
示例值
描述
Action
String
是

CreateInstance

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

Version
String
是

2023-01-01

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

AllowListIds
Array of String
否

{"acl-2e6694dd6ef3496c9a00aeaf56a7****","acl-4848ddb745fe49b3947c5dbdfbb6****"}

实例绑定的白名单 ID 列表。绑定白名单后，仅配置在白名单中的 IP 地址与地址段才能访问此实例。如果实例未绑定任何白名单，表示禁止所有 IP 地址访问该实例。

IPVersionType
String
否

IPv4

IP 版本， 可选直为 IPv4 或者 DualStack。

ClientToken
String
否

123e4567-e89b-12d3-a456-426655440000

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

EnableSSL
Boolean
否

true

是否使用 SSL 加密。

BindTags
Array of Object
否

/

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

Version
String
是

4.8

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

  • 4.8：兼容 RocketMQ 4.x 版本系列。
  • 5.x：兼容 RocketMQ 5.x 版本系列。目前 5.x 版本处于加白阶段，如需使用请联系技术支持申请开白。
ZoneId
String
是

cn-beijing-a

实例所在的可用区 ID。
消息队列 RocketMQ版实例支持跨 AZ 部署，查看指定可用区下提供哪些计算规格时，可以指定多个可用区。多个可用区 ID 之间以逗号（,）间隔。
您可以调用 DescribeAvailabilityZones 查询当前提供服务的可用区列表。

ComputeSpec
String
是

rocketmq.n1.x2.small

实例的计算规格。
您可以在产品规格中查看目前在售的计算规格列表。

StorageSpace
Integer
是

1000

实例的存储空间。
单位为 GiB，必须指定为 100 的倍数。取值范围取决于当前指定的计算规格。

VpcId
String
是

vpc-13fo9gkz6j6683n6nu5ec****

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

  • 实例创建完成后，不可修改对应的私有网络和子网。创建实例时请谨慎操作。
  • 您可以调用私有网络（VPC）的 DescribeVpcs 接口查询可用的VPC和子网列表。
SubnetId
String
是

subnet-min6uy01kuf45smt1a2i****

实例所在的 VPC 子网 ID。

  • 实例创建完成后，不可修改对应的私有网络和子网。创建实例时请谨慎操作。
  • 您可以调用私有网络（VPC）的 DescribeVpcs 接口查询可用的VPC和子网列表。
FileReservedTime
Integer
是

72

消息在消息队列 RocketMQ版服务端的保留时长，超过保留时长的消息将被过期清理。单位为小时，取值范围为 1~72 小时。

InstanceName
String
否

Name123

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

  • 只能包含中文、字母、数字、下划线（_）和连字符（-）。
  • 不能以数字和连字符（-）开头。
  • 长度范围为 1~128 个字符。

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

ChargeInfo
Object
是

/

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

SSLMode
String
否

enforcing

实例的公网连接策略，仅在开启公网访问时需要设置。支持设置为：

  • enforcing：通过公网访问实例时，必须经由 SSL 认证。SSL 认证可实现数据的加密传输，相较于普通公网访问方式具备更高的安全性，但性能会有所下降。
  • permissive：通过公网访问实例时，可以选择是否经由 SSL 认证。
    创建实例后，公网访问为开启状态时，不能修改 SSL 连接策略。如需修改，需要为实例关闭并重新开启公网访问，在重新开启时再次设置 SSL 连接策略。详细说明请参考设置公网访问与 SSL 认证策略。
NetworkTypes
String
是

PrivateNetwork

实例网络类型，固定为 PrivateNetwork。

ProjectName
String
否

newproject

当前创建的实例所属的 IAM 项目。若未设置，则会将新实例绑定到名为 default 的 IAM 项目中。

InstanceDescription
String
否

instance for test

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

EipId
String
否

eip-mjhulvqza6805smt1bnc****

EIP 的 ID。

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

返回参数

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

参数
类型
示例值
描述
InstanceId
String

rocketmq-cnngd5xxxxxxxx

实例ID。

OrderId
String

order-72f5p5h5158f

订单ID。

请求示例

POST /?Action=CreateInstance&Version=2023-01-01 HTTP/1.1
Content-Type: application/json
Host: rocketmq.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-shanghai/rocketmq/request, SignedHeaders=x-date, Signature=********

{
    "ZoneId": "cn-shanghai-a",
    "Version": "4.8",
    "ComputeSpec": "rocketmq.n1.x2.micro",
    "StorageSpace": 300,
    "VpcId": "vpc-3qe3nxqooqccg7prmkznr****",
    "SubnetId": "subnet-22j3oc7a7rvuo7r2qr29u****",
    "NetworkTypes": "PrivateNetwork",
    "ChargeInfo": {
        "ChargeType": "PostPaid"
    },
    "FileReservedTime": 72
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202302271904532FE25613615E5671AB07",
        "Action": "CreateInstance",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-shanghai"
    },
    "Result": {
        "InstanceId": "rocketmq-cnai1f0c29ca****",
        "OrderId": "Order720478931462498****"
    }
}

错误码

公共错误码请参见公共错误码文档。