文档

CreateInstance - 创建实例

更新时间:

创建云消息队列 RocketMQ 版5.x系列实例。

接口说明

注意 阿里云提供的 OpenAPI 属于管控类 API,用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成,消息收发的核心数据链路中严禁依赖 OpenAPI 实现,否则可能会导致链路产生风险。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rocketmq:CreateInstancecreate
  • Instance
    acs:rocketmq:{#regionId}:{#accountId}:Instance/*

请求语法

POST /instances HTTP/1.1

请求参数

名称类型必填描述示例值
clientTokenstring

用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大不超过 64 个 ASCII 字符。

c2c5d1274a8d4317a13bc5b0d4******
bodyobject

body 参数。

instanceNamestring

待创建的实例名称。

不填写则以实例 ID 作为实例名称

rmq-cn-72u3048uxxx
serviceCodestring

实例所属的服务编码。消息队列 RocketMQ 版的服务编码为 rmq。

rmq
seriesCodestring

实例的主系列编码。主系列间的具体差异,请参见产品选型

参数取值如下:

  • standard:标准版
  • ultimate:铂金版
  • professional:专业版

注意 实例创建成功后,主系列只支持单向变更,只升不降,变更方向为:标准版 > 专业版 > 铂金版。例如,只支持从标准版变更到专业版,不支持从专业版降为标准版。

standard
subSeriesCodestring

实例的子系列编码。子系列间具体差异,请参见产品选型

参数取值如下:

  • cluster_ha:集群高可用版

  • single_node:单节点测试版

  • serverless:Serverless 实例

主系列选择 ultimate(铂金版)时,子系列只能选择为 cluster_ha(集群高可用版)。

注意 实例创建成功后,子系列不支持变更。

枚举值:
  • serverlessServerless版
  • cluster_ha集群高可用版
  • single_node单节点测试版
cluster_ha
paymentTypestring

实例的付费类型。云消息队列 RocketMQ 版支持包年包月和按量付费两种类型。

参数取值如下:

  • PayAsYouGo:按量付费,一种后付费模式,即先使用再付费。
  • Subscription:包年包月,一种预付费模式,即先付费再使用。

具体信息,请参见计费方式

Subscription
periodinteger

购买时长。仅当实例付费类型为 Subscription(包年包月)时,该参数生效。

取值范围如下:

  • 按月购买:1、2、3、4、5、6

  • 按年购买:1、2、3

3
periodUnitstring

购买时长的最小周期单位。

参数取值如下:

  • Month:按月购买
  • Year:按年购买
Month
autoRenewboolean

是否自动续费。仅当实例付费类型为 Subscription(包年包月)时,该参数生效。

  • true:开启自动续费
  • false:不开启自动续费
true
autoRenewPeriodinteger

自动续费周期。仅当开启自动续费时该参数有效。单位:月。

取值范围:

  • 按月续费:1、2、3、6、12
3
remarkstring

实例的备注信息。

This is the remark for test.
productInfoobject

实例规格信息。

msgProcessSpecstring

消息收发计算规格。具体消息收发 TPS 上限,请参见实例规格

rmq.s2.2xlarge
sendReceiveRatiofloat

消息发送 TPS 占整个实例消息收发 TPS 总量的比例。

例如,实例的消息收发 TPS 上限为 1000 次/秒,若消息发送占比为 0.8,则消息发送 TPS 上限为 800 次/秒,消息接收 TPS 上限为 200 次/秒。

取值范围:[0,1],默认值为 0.5。

0.5
autoScalingboolean

是否开启规格外突发弹性能力。

参数取值如下:

  • true:开启弹性能力
  • false:不开启弹性能力

开启弹性突发能力后,云消息队列 RocketMQ 版允许该实例在一定范围内超过基础规格限制的 TPS,且超过基础规格外的部分,需要收取额外的弹性规格费用。具体计费信息,请参见计算能力费用

说明 仅部分规格的实例支持开启弹性突发规格能力,具体支持的实例,请参见实例规格
true
messageRetentionTimeinteger

消息保存时长。单位:小时。

取值范围,请参见使用限制>资源配额>消息保存时长的限制值。

云消息队列 RocketMQ 版的消息存储完全实现 Serverless 弹性,按照实际存储空间收取费用,您可以通过调整消息保存时长来控制消息的存储容量。更多信息,请参见存储费用

72
chargeTypestring

计费模式。

参数取值如下:

  • provisioned:预留
  • ondemand:弹性
provisioned
intranetSpecstring

废弃参数,您无需填写。

xxxx
networkInfoobject

网络配置信息。

vpcInfoobject

专有网络配置信息。

vpcIdstring

待创建实例所关联的专有网络的 ID。

说明 云消息队列 RocketMQ 版实例创建后,选择的 VPC 不支持变更。若要修改关联的 VPC,您需要先释放已购买的云消息队列 RocketMQ 版实例,再重新购买。
vpc-wz9qt50xhtj9krb******
vSwitchIddeprecatedstring

实例所关联的交换机 ID,当有多个交换机时,请以“|“进行拼接。

说明 云消息队列 RocketMQ 版实例创建后,选择的交换机不支持变更。若要修改关联的交换机,您需要先释放已购买的云消息队列 RocketMQ 版实例,再重新购买。
vsw-uf6gwtbn6etadpv*******
securityGroupIdsstring

安全组 ID。

sg-bp17hpmgz96tvnsdy6so
vSwitchesarray<object>

交换机列表

object
vSwitchIdstring

实例所关联的交换机 ID,当有多个交换机时,请以“|“进行拼接。

vsw-uf6gwtbn6etadpv*******
internetInfoobject

公网配置信息。

internetSpecstring

是否开通公网访问。

参数取值如下:

  • enable:开启公网访问
  • disable:关闭公网访问

实例默认支持 VPC 访问方式,若开启公网访问,云消息队列 RocketMQ 版会收取公网下行带宽费用。具体计费信息,请参见公网访问费用

disable
flowOutTypestring

公网计费类型。

参数取值如下:

  • payByBandwidth:固定带宽计费。开启公网访问时,设置为该参数取值。
  • payByTraffic:按流量计费。开启公网访问时,设置为该参数取值。
  • uninvolved:不涉及。关闭公网访问时,设置为该参数取值。
uninvolved
flowOutBandwidthinteger

公网带宽规格。单位:Mb/s。

只有在公网计费类型为按固定带宽计费的时候才需要填写。

取值范围:[1 - 1000]。

100
ipWhitelistarray

公网访问 IP 白名单。仅公网接入点支持配置 IP 白名单,VPC 接入点暂不支持。

  • 若不配置 IP 白名单,则默认放通所有 IP 地址段通过公网访问云消息队列 RocketMQ 版服务端。
  • 若配置 IP 白名单,则仅允许白名单内的 IP 地址通过公网访问云消息队列 RocketMQ 版服务端。
string

公网访问白名单地址段。

192.168.x.x/24
commodityCodestring

商品编码。

  • ons_rmqsub_public_cn:包年包月实例

  • ons_rmqpost_public_cn:按量付费实例

  • ons_rmqsrvlesspost_public_cn :Serverless 实例

ons_ rmqpost_public_cn
resourceGroupIdstring

资源组 ID。

rg-aekzy6pist7uuna

返回参数

名称类型描述示例值
object

返回数据。

requestIdstring

请求 ID,每个请求 ID 都是唯一的,可用于排查和定位问题。

AF9A8B10-C426-530F-A0DD-96320B39****
successboolean

执行结果是否成功。

true
datastring

返回已创建实例的 ID。

rmq-cn-7e22ody****
codestring

错误码。

200
messagestring

错误信息。

Success
httpStatusCodeinteger

HTTP 状态码。

200
dynamicCodestring

动态错误码。

InstanceId
dynamicMessagestring

动态错误信息。

instanceId

示例

正常返回示例

JSON格式

{
  "requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
  "success": true,
  "data": "rmq-cn-7e22ody****",
  "code": "200",
  "message": "Success",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-07-03API 内部配置变更,不影响调用查看变更详情
2023-10-09API 内部配置变更,不影响调用查看变更详情
2023-10-09OpenAPI 入参发生变更查看变更详情
2023-10-09OpenAPI 入参发生变更查看变更详情