云原生消息引擎
云原生消息引擎
文档指南
请输入
- 文档首页
云原生消息引擎BMQ 实例用户指南API 参考实例管理CreateInstance - 创建实例
复制全文
下载 pdfCreateInstance - 创建实例
文档反馈
问问助手调用 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：包年包月。
Description string 可选 示例值：测试使用
实例的简单描述。
ProjectName string 可选 示例值：default
实例所属项目名称。
您可以对不同业务或项目使用的云资源进行分组管理。基于项目进行 IAM 授权，有利于维护资源独立、数据安全；同时可从项目维度查看资源消费账单，便于计算云资源使用成本。
SubnetIdList string[] 必选 示例值：["subnet-13f59****p69s3n6nu58jcb7b"]
配置实例的子网 ID。
说明
若实例为多可用区部署，需要为每个可用区设置一个子网，各子网 ID 之间使用英文逗号（,）分隔。
BillingPeriod string 可选 示例值：MONTHLY
购买时长的单位，取值如下：
- MONTHLY：按月购买。
- YEARLY：按年购买。
说明
仅包年包月实例需要配置该参数，按量计费类型实例请忽略。
Specification string 必选 示例值：bmq.standard
实例规格。
MessageRetention integer 可选 示例值：96
设置实例下所有 Topic 的默认消息保留时长，单位为小时。
- 默认为 72 小时，可按小时粒度调节。
- 支持设置的保留时间范围为 1~336 小时（14 天）。
SecurityGroupIdList 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"
}
}
错误码
状态码 | 错误码 | 错误信息 | 说明 |
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 |
最近更新时间：2025.08.05 18:34:37
这个页面对您有帮助吗？
有用
有用
无用
无用