You need to enable JavaScript to run this app.
导航

CreateInstance

最近更新时间2023.07.12 16:47:03

首次发布时间2021.08.30 16:57:43

调用 CreateInstance 接口创建 RocketMQ 实例。

使用说明

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

说明

  • 通过 API 创建接口时暂不支持同时开启公网访问功能,如果需要开启实例的公网访问,建议在创建实例完成后,实例状态为运行中(Running)时,调用 EnablePublicNetwork 开启实例的公网访问。
  • 默认情况下,您可以在每个地域中创建 5 个 RocketMQ 实例,且每个账号在每个地域中的所有实例存储容量总和最大为 10TiB,否则创建实例时报错The InstanceNum/StorageSum has exceeded quota。如需提高配额,请在配额中心提交申请,例如提高每个地域下的最大实例数量(InstanceNum),最高可调整至 10 个。

请求参数

参数

参数类型

是否必选

示例值

说明

Type

String

必选

Exclusive

实例类型。固定为 Exclusive

Region

String

必选

cn-beijing

实例所在的地域。
消息队列 RocketMQ版支持多可用区部署 RocketMQ 实例,对于 3 个及以上可用区的地域,您可以通过指定 3 个可用区的方式实现跨可用区部署。多个可用区之间通过英文逗号(,)分隔,例如 cn-guangzhou-a,cn-guangzhou-b

说明

多可用区部署为邀测功能,若有相关业务需求,请通过工单系统联系技术支持申请白名单。

Zone

String

必选

cn-beijing-a

实例所在可用区。

RocketMQVersion

String

必选

4.8

RocketMQ 版本。目前仅支持 4.8 版本。

ComputeResource

ComputeConfig

必选

计算规格。
详细说明请参考 ComputeConfig

StorageResource

StorageConfig

可选

存储规格。
详细说明请参考 StorageConfig

VpcNetwork

String

必选

Exclusive

网络类型。固定为 Exclusive

VpcId

String

必选

vpc****

私有网络(VPC)的 ID。
实例创建完成后,不可修改对应的私有网络,请谨慎操作。

SubnetID

String

必选

s***

VPC 子网 ID。

UsedTime

Integer

必选

0

实例的购买时长。

  • 包年包月实例需要指定此参数,单位为月,取值范围为 1~36。
  • 按量付费实例请指定 UsedTime 为0。

OneStep

Bool

必选

true

是否直接下单并自动支付,必须指定为 true,即直接下单并支付。

AutoRenew

Bool

必选

false

是否自动续费,包年包月必传。

ChargeType

String

必选

PostPaid

实例的计费类型。支持设置为:

  • PostPaid:按量计费。
  • PrePaid:包年包月。

ChargeSubType

String

必选

Monthly

对于包年包月实例,需要指定购买的时长单位。

  • Monthly:以月为单位购买。
  • Yearly:以年为单位购买。

ProjectName

String

可选

project

实例所属的IAM项目。默认情况下,消息队列 RocketMQ版不会将实例添加到任何IAM项目中。

InstanceName

String

可选

rocketmq

RocketMQ 实例名称。需满足以下要求:

  • 只能包含中文、英文字母、数字、下划线(_)和连字符(-)。
  • 不能以数字或连字符(-)开头。
  • 长度为 0~128 字符。
    未设置 RocketMQ 实例名称时,将用实例 ID 作为实例名称。

FileReservedTime

Integer

可选

168

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

说明

  • 过长的消息保留时长会导致消息存储量较大、占用实例存储空间,过短则可能导致消息未被消费就被清理。请根据业务需求合理设置消息保留时长。
  • 创建实例后,不支持修改实例的消息保留时长。

Description

String

可选

Instance Description

实例的描述信息。

响应参数

参数

参数类型

示例值

说明

InstanceId

String

MQ_INST_********

实例 ID。

OrderId

String


订单 ID。

示例

请求示例

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

{
  "InstanceName": "InstanceName",
  "Description": "Instance Description",
  "VpcNetwork": "Exclusive",
  "VpcId": "vpc-***",
  "Type": "Exclusive",
  "Region": "cn-beijing",
  "Zone": "cn-beijing-a",
  "RocketMQVersion": "4.8",
  "ComputeResource": {
    "NormType": "rocketmq.n1.x2.medium"
  },
  "StorageResource": {
    "NormType": "rocketmq.n1.x2.medium",
    "Value": 600
  },
  "UsedTime": 0,
  "OneStep": true,
  "AutoRenew": false,
  "ChargeType": "PostPaid",
  "ChargeSubType": "Monthly",
  "ProjectName": "new",
  "SubnetID": "s***"
}

响应示例

{
  "ResponseMetadata": {
    "RequestId": "*********************",
    "Action": "CreateInstance",
    "Version": "2021-04-01",
    "Service": "rocketmq",
    "Region": "cn-beijing"
  },
  "Result": {
    "InstanceId": "MQ_INST_********",
    "OrderId": "*******"
  }
}