创建云消息队列 RocketMQ 版5.x系列实例。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
rocketmq:CreateInstance |
create |
*Instance
|
无 | 无 |
请求语法
POST /instances HTTP/1.1
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
clientToken |
string |
否 |
用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大不超过 64 个 ASCII 字符。 |
c2c5d1274a8d4317a13bc5b0d4****** |
body |
object |
否 |
body 参数。 |
|
instanceName |
string |
否 |
待创建的实例名称。 不填写则以实例 ID 作为实例名称 |
rmq-cn-72u3048uxxx |
serviceCode |
string |
是 |
实例所属的服务编码。消息队列 RocketMQ 版的服务编码为 rmq。 |
rmq |
seriesCode |
string |
是 |
实例的主系列编码。主系列间的具体差异,请参见产品选型。 参数取值如下:
重要 实例创建成功后,主系列只支持单向变更,只升不降,变更方向为:标准版 > 专业版 > 铂金版。例如,只支持从标准版变更到专业版,不支持从专业版降为标准版。 枚举值:
|
standard |
subSeriesCode |
string |
是 |
实例的子系列编码。子系列间具体差异,请参见产品选型。 参数取值如下:
主系列选择 ultimate(铂金版)时,子系列只能选择为 cluster_ha(集群高可用版)。 重要 实例创建成功后,子系列不支持变更。 枚举值:
|
cluster_ha |
paymentType |
string |
是 |
实例的付费类型。云消息队列 RocketMQ 版支持包年包月和按量付费两种类型。 参数取值如下:
具体信息,请参见计费方式。 枚举值:
|
Subscription |
period |
integer |
否 |
购买时长。仅当实例付费类型为 Subscription(包年包月)时,该参数生效。 取值范围如下:
|
3 |
periodUnit |
string |
否 |
购买时长的最小周期单位。 参数取值如下:
枚举值:
|
Month |
autoRenew |
boolean |
否 |
是否自动续费。仅当实例付费类型为 Subscription(包年包月)时,该参数生效。
枚举值:
|
true |
autoRenewPeriod |
integer |
否 |
自动续费周期。仅当开启自动续费时该参数有效。单位:月。 取值范围:
|
3 |
remark |
string |
否 |
实例的备注信息。 |
This is the remark for test. |
productInfo |
object |
否 |
实例规格信息。 |
|
msgProcessSpec |
string |
否 |
消息收发计算规格。具体消息收发 TPS 上限,请参见实例规格。 |
rmq.s2.2xlarge |
sendReceiveRatio |
number |
否 |
消息发送 TPS 占整个实例消息收发 TPS 总量的比例。 例如,实例的消息收发 TPS 上限为 1000 次/秒,若消息发送占比为 0.8,则消息发送 TPS 上限为 800 次/秒,消息接收 TPS 上限为 200 次/秒。 取值范围:[0,1],默认值为 0.5。 |
0.5 |
autoScaling |
boolean |
否 |
是否开启规格外突发弹性能力。 参数取值如下:
开启弹性突发能力后,云消息队列 RocketMQ 版允许该实例在一定范围内超过基础规格限制的 TPS,且超过基础规格外的部分,需要收取额外的弹性规格费用。具体计费信息,请参见计算能力费用。 说明
仅部分规格的实例支持开启弹性突发规格能力,具体支持的实例,请参见实例规格。 枚举值:
|
true |
messageRetentionTime |
integer |
否 |
消息保存时长。单位:小时。 取值范围,请参见使用限制>资源配额>消息保存时长的限制值。 云消息队列 RocketMQ 版的消息存储完全实现 Serverless 弹性,按照实际存储空间收取费用,您可以通过调整消息保存时长来控制消息的存储容量。更多信息,请参见存储费用。 |
72 |
storageEncryption |
boolean |
否 |
是否开启存储加密 |
false |
storageSecretKey |
string |
否 |
存储加密密钥 Key |
xxxxx |
capacityType |
string |
否 |
||
provisionedCapacity |
integer |
否 |
||
networkInfo |
object |
是 |
网络配置信息。 |
|
vpcInfo |
object |
是 |
专有网络配置信息。 |
|
vpcId |
string |
是 |
待创建实例所关联的专有网络的 ID。 说明
云消息队列 RocketMQ 版实例创建后,选择的 VPC 不支持变更。若要修改关联的 VPC,您需要先释放已购买的云消息队列 RocketMQ 版实例,再重新购买。 |
vpc-wz9qt50xhtj9krb****** |
vSwitchId
deprecated
|
string |
否 |
实例所关联的交换机 ID,当有多个交换机时,请以“|“进行拼接。 说明
云消息队列 RocketMQ 版实例创建后,选择的交换机不支持变更。若要修改关联的交换机,您需要先释放已购买的云消息队列 RocketMQ 版实例,再重新购买。 重要 该字段不推荐使用,请使用 vSwitches 字段 |
vsw-uf6gwtbn6etadpv******* |
securityGroupIds |
string |
否 |
安全组 ID。 |
sg-bp17hpmgz96tvnsdy6so |
vSwitches |
array |
否 |
交换机列表。 说明
云消息队列 RocketMQ 版实例创建后,选择的交换机不支持变更。若要修改关联的交换机,您需要先释放已购买的云消息队列 RocketMQ 版实例,再重新购买。 重要 必填字段,由于 vSwitchId 字段已不推荐使用,请使用该字段设置交换机 |
|
object |
否 |
|||
vSwitchId |
string |
否 |
实例所关联的交换机 ID。 |
vsw-uf6gwtbn6etadpv******* |
internetInfo |
object |
是 |
公网配置信息。 |
|
internetSpec |
string |
是 |
是否开通公网访问。 参数取值如下:
实例默认支持 VPC 访问方式,若开启公网访问,云消息队列 RocketMQ 版会收取公网下行带宽费用。具体计费信息,请参见公网访问费用。 枚举值:
|
disable |
flowOutType |
string |
是 |
公网计费类型。 参数取值如下:
枚举值:
|
uninvolved |
flowOutBandwidth |
integer |
否 |
公网带宽规格。单位:Mb/s。 只有在公网计费类型为按固定带宽计费的时候才需要填写。 取值范围:[1 - 1000]。 |
100 |
ipWhitelist
deprecated
|
array |
否 |
公网访问 IP 白名单。仅公网接入点支持配置 IP 白名单,VPC 接入点暂不支持。
|
|
string |
否 |
公网访问白名单地址段。 |
192.168.x.x/24 |
|
commodityCode |
string |
否 |
商品编码。
|
ons_ rmqpost_public_cn |
resourceGroupId |
string |
否 |
资源组 ID。 |
rg-aekzy6pist7uuna |
tags |
array |
否 |
资源标签列表 |
|
object |
否 |
资源标签。 |
||
key |
string |
否 |
资源标签 key 值。 |
xxxKey |
value |
string |
否 |
资源标签 value 值。 |
xxxValue |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
返回数据。 |
||
requestId |
string |
请求 ID,每个请求 ID 都是唯一的,可用于排查和定位问题。 |
AF9A8B10-C426-530F-A0DD-96320B39**** |
success |
boolean |
执行结果是否成功。 |
true |
data |
string |
返回已创建实例的 ID。 |
rmq-cn-7e22ody**** |
code |
string |
错误码。 |
200 |
message |
string |
错误信息。 |
Success |
httpStatusCode |
integer |
HTTP 状态码。 |
200 |
dynamicCode |
string |
动态错误码。 |
InstanceId |
dynamicMessage |
string |
动态错误信息。 |
instanceId |
示例
正常返回示例
JSON
格式
{
"requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
"success": true,
"data": "rmq-cn-7e22ody****",
"code": "200",
"message": "Success",
"httpStatusCode": 200,
"dynamicCode": "InstanceId",
"dynamicMessage": "instanceId"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。