调用 CreateInstance 接口，创建 BMQ 实例。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | CreateInstance | 要执行的操作，取值：CreateInstance。 |
Version | String | 是 | 2023-06-01 | API的版本，取值：2023-06-01。 |
Name | String | 是 | bmq-test | 自定设置 BMQ 实例的名称，约束限制如下：
|
EipId | String | 否 | eip-mixfado****c5smt1axs1d7m | 实例是否开启公网访问。如果需要开启公网访问，请配置相同地域的公网 IP 的 ID。 |
Times | Integer | 否 | 6 | 包年包月类型实例的购买时长，单位为月。 说明 仅包年包月类型需要配置该参数，按量计费类型实例请忽略。 |
VpcId | String | 是 | vpc-mj1u****3o5c5smt1bs88jem | 为实例配置私有网络 VPC ID。 |
AutoRenew | Boolean | 否 | true | 是否开启自动续费，取值如下：
说明 仅包年包月类型需要配置该参数，按量计费类型实例请忽略。 |
ZoneIdList | Array of String | 是 | ["cn-beijing-c"] | 可用区ID列表。 说明 如果是多可用区部署，各可用区 ID 之间使用英文逗号（,）分隔。 |
BillingType | String | 是 | POST | 实例的计费方式，取值如下：
说明 包年包月类型的 BMQ 实例本质上是混合计费，计算规格包年包月，存储规格使用 CloudFS 加速存储并使用按量计费方式进行核算。 |
Description | String | 否 | 测试使用 | 实例的简单描述。 |
ProjectName | String | 否 | default | 实例所属项目名称。 |
SubnetIdList | Array of String | 是 | ["subnet-13f59****p69s3n6nu58jcb7b"] | 配置实例的子网 ID。 说明 若实例为多可用区部署，需要为每个可用区设置一个子网，各子网 ID 之间使用英文逗号（,）分隔。 |
BillingPeriod | String | 否 | MONTHLY | 购买时长的单位，取值如下：
说明 仅包年包月实例需要配置该参数，按量计费类型实例请忽略。 |
Specification | String | 是 | bmq.standard | 实例规格。 |
MessageRetention | Integer | 否 | 96 | 设置实例下所有 Topic 的默认消息保留时长，单位为小时。
|
SecurityGroupIdList | Array of String | 是 | ["sg-mj1u****fu2o5smt1aem4ps4"] | 安全组 ID 列表。 说明 BMQ 实例访问地址的默认端口为 9092，您需要在安全组中放开对应端口。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
InstanceId | String | o-00c0****m46c | 新建的 BMQ 实例 ID。 |
POST /?Action=CreateInstance&Version=2023-06-01 HTTP/1.1 Host: bmq.volcengineapi.com Content-Type: application/json; charset=UTF-8 X-Date: 20241104T134310Z X-Content-Sha256: 287e874e******d653b44d21e Authorization: HMAC-SHA256 Credential=AK********/20241104/cn-beijing/bmq/request, SignedHeaders=host;x-content-sha256;x-date, Signature=******** { "Name": "bmq-test", "VpcId": "vpc-mj1u****3o5c5smt1bs88jem", "AutoRenew": "true", "ZoneIdList": ["cn-beijing-c"], "AuthEnabled": "true", "BillingType": "POST", "ProjectName": "default", "SubnetIdList": ["subnet-13f59****p69s3n6nu58jcb7b"], "Specification": "bmq.xlarge", "MessageRetention": "72", "SecurityGroupIdList": ["sg-mj1u****fu2o5smt1aem4ps4"] }
{ "ResponseMetadata": { "RequestId": "20241205140355961CA17F2F1A981F****", "Action": "CreateInstance", "Version": "2023-06-01", "Service": "bmq", "Region": "cn-beijing" }, "Result": { "InstanceId": "o-00c0****m46c" } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。