创建云消息队列 RocketMQ 版5.x系列实例。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rocketmq:CreateInstance | create |
|
| 无 |
请求语法
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 | float | 否 | 消息发送 TPS 占整个实例消息收发 TPS 总量的比例。 例如,实例的消息收发 TPS 上限为 1000 次/秒,若消息发送占比为 0.8,则消息发送 TPS 上限为 800 次/秒,消息接收 TPS 上限为 200 次/秒。 取值范围:[0,1],默认值为 0.5。 | 0.5 |
autoScaling | boolean | 否 | true | |
messageRetentionTime | integer | 否 | 72 | |
chargeType | string | 否 | 计费模式。 参数取值如下:
| provisioned |
intranetSpec | string | 否 | 废弃参数,您无需填写。 | xxxx |
networkInfo | object | 是 | 网络配置信息。 | |
vpcInfo | object | 是 | 专有网络配置信息。 | |
vpcId | string | 是 | 待创建实例所关联的专有网络的 ID。 说明
云消息队列 RocketMQ 版实例创建后,选择的 VPC 不支持变更。若要修改关联的 VPC,您需要先释放已购买的云消息队列 RocketMQ 版实例,再重新购买。
| vpc-wz9qt50xhtj9krb****** |
vSwitchIddeprecated | string | 否 | 实例所关联的交换机 ID,当有多个交换机时,请以“|“进行拼接。 说明
云消息队列 RocketMQ 版实例创建后,选择的交换机不支持变更。若要修改关联的交换机,您需要先释放已购买的云消息队列 RocketMQ 版实例,再重新购买。
| vsw-uf6gwtbn6etadpv******* |
securityGroupIds | string | 否 | 安全组 ID。 | sg-bp17hpmgz96tvnsdy6so |
vSwitches | array<object> | 否 | 交换机列表 | |
object | 否 | |||
vSwitchId | string | 否 | 实例所关联的交换机 ID,当有多个交换机时,请以“|“进行拼接。 | vsw-uf6gwtbn6etadpv******* |
internetInfo | object | 是 | 公网配置信息。 | |
internetSpec | string | 是 | 是否开通公网访问。 参数取值如下:
实例默认支持 VPC 访问方式,若开启公网访问,云消息队列 RocketMQ 版会收取公网下行带宽费用。具体计费信息,请参见公网访问费用。 | disable |
flowOutType | string | 是 | 公网计费类型。 参数取值如下:
| uninvolved |
flowOutBandwidth | integer | 否 | 公网带宽规格。单位:Mb/s。 只有在公网计费类型为按固定带宽计费的时候才需要填写。 取值范围:[1 - 1000]。 | 100 |
ipWhitelist | array | 否 | 公网访问 IP 白名单。仅公网接入点支持配置 IP 白名单,VPC 接入点暂不支持。
| |
string | 否 | 公网访问白名单地址段。 | 192.168.x.x/24 | |
commodityCode | string | 否 | 商品编码。
| ons_ rmqpost_public_cn |
resourceGroupId | string | 否 | 资源组 ID。 | rg-aekzy6pist7uuna |
返回参数
示例
正常返回示例
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-03 | API 内部配置变更,不影响调用 | 查看变更详情 |
2023-10-09 | API 内部配置变更,不影响调用 | 查看变更详情 |
2023-10-09 | OpenAPI 入参发生变更 | 查看变更详情 |
2023-10-09 | OpenAPI 入参发生变更 | 查看变更详情 |