调用 CreateInstance 接口，创建 BMQ 实例。

请求说明

请求方式：POST

请求地址：https://open.volcengineapi.com?Action=CreateInstance&Version=2023-06-01

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：CreateInstance

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

Version string 必选示例值：2023-06-01

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

Name string 必选示例值：bmq-test

自定设置 BMQ 实例的名称，约束限制如下：

由小写字母、数字和中划线（-）组成。

长度为 1~64 字符。

EipId string 可选示例值：eip-mixfado****c5smt1axs1d7m

实例是否开启公网访问。如果需要开启公网访问，请配置相同地域的公网 IP 的 ID。

Times integer 可选示例值：6

包年包月类型实例的购买时长，单位为月。

说明

仅包年包月类型需要配置该参数，按量计费类型实例请忽略。

VpcId string 必选示例值：vpc-mj1u****3o5c5smt1bs88jem

为实例配置私有网络 VPC ID。

AutoRenew boolean 可选示例值：true

是否开启自动续费，取值如下：

true：开启自动续费。

false：关闭自动续费。在实例到期前需要进行手动续费，如需了解更多，请参见续费说明。

说明

仅包年包月类型需要配置该参数，按量计费类型实例请忽略。

ZoneIdList string[] 必选示例值：["cn-beijing-c"]

可用区ID列表。

说明

如果是多可用区部署，各可用区 ID 之间使用英文逗号（,）分隔。

BillingType string 必选示例值：POST

实例的计费方式，取值如下：

POST：按量计费。

MIX：包年包月。

说明

包年包月类型的 BMQ 实例本质上是混合计费，计算规格包年包月，存储规格使用 CloudFS 加速存储并使用按量计费方式进行核算。

如需了解计费详情，请参见计费说明。

Description string 可选示例值：测试使用

实例的简单描述。

ProjectName string 可选示例值：default

实例所属项目名称。

您可以对不同业务或项目使用的云资源进行分组管理。基于项目进行 IAM 授权，有利于维护资源独立、数据安全；同时可从项目维度查看资源消费账单，便于计算云资源使用成本。

SubnetIdList string[] 必选示例值：["subnet-13f59****p69s3n6nu58jcb7b"]

配置实例的子网 ID。

说明

若实例为多可用区部署，需要为每个可用区设置一个子网，各子网 ID 之间使用英文逗号（,）分隔。

BillingPeriod string 可选示例值：MONTHLY

购买时长的单位，取值如下：

MONTHLY：按月购买。

YEARLY：按年购买。

说明

仅包年包月实例需要配置该参数，按量计费类型实例请忽略。

Specification string 必选示例值：bmq.standard

实例规格。

根据业务场景的 Topic 数量、Consumer Group 数量、分区数量等要求，选择合适的实例规格。相关文档，请参见实例规格。

MessageRetention integer 可选示例值：96

设置实例下所有 Topic 的默认消息保留时长，单位为小时。

默认为 72 小时，可按小时粒度调节。

支持设置的保留时间范围为 1~336 小时（14 天）。

SecurityGroupIdList string[] 必选示例值：["sg-mj1u****fu2o5smt1aem4ps4"]

安全组 ID 列表。

说明

BMQ 实例访问地址的默认端口为 9092，您需要在安全组中放开对应端口。

返回参数

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

InstanceId string 示例值：o-00c0****m46c

新建的 BMQ 实例 ID。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
200	InvalidParameter	parameter is invalid, pls check parameters	参数值无效。
200	Unauthorized	authorized error	授权错误，请授权或切换账号后重试。
200	InternalServiceError	internal service error, please contact with admin	内部服务错误，请联系技术支持或提交工单。
200	DatabaseError	database error	数据库错误。
200	ParameterEncodingError	Failure encoding object into query map	参数编码异常，请联系技术支持或提交工单。

云原生消息引擎