消息队列 Kafka版
消息队列 Kafka版
文档指南
请输入
- 文档首页
消息队列 Kafka版API 参考V2（2022-05-01）OpenAPIV2CreateInstance - 创建实例
复制全文
下载 pdfCreateInstance - 创建实例
文档反馈
问问助手调用 CreateInstance 创建消息队列 Kafka版实例。
使用说明
实例是消息队列 Kafka版服务的虚拟机资源，用于管理和存储 Topic、Group 等资源。
注意事项
- 如果是首次创建 Kafka 实例，您需要先完成跨服务访问授权，建议通过火山引擎主账号操作。详细说明请参考跨服务访问授权。
- 如果需要通过私有网络访问消息队列 Kafka版实例，请先在相同地域创建 ECS 云服务器、私有网络和子网。创建实例后，不可更改实例所在的私有网络和子网。
- 如果需要通过公网访问消息队列 Kafka版实例，请先申请同地域的 EIP，详细操作步骤请参考申请公网IP。
- 默认情况下，您可以在每个地域中创建 8 个 Kafka 实例，每个账号在每个地域中的所有实例存储容量总和最大为 90TiB，否则创建实例时报错“The instance_num/storage_sum has exceeded quota”。如需提高配额，请在配额中心提交申请，例如申请提高每个地域下的最大实例数量（InstanceNum），最高可调整至 16 个。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：CreateInstance
要执行的操作，取值：CreateInstance。
Version string 必选 示例值：2022-05-01
API的版本，取值：2022-05-01。
ZoneId string 必选 示例值：cn-beijing-a
实例所在的可用区 ID。
UserPassword string 可选 示例值：Test@123456
SASL/PLAIN 用户的密码。需要满足以下要求：
- 长度为 8~32 个字符。
- 由大写字母、小写字母、数字、特殊字符中的任意三种组成。
- 支持的特殊字符包括 !@#$%^&*()_+-=。
UserName string 可选 示例值：Test1
SASL/PLAIN 用户名称。需要满足以下要求：
- 由小写字母、数字、连字符（-）或下划线组成。
- 长度为 3~64 个字符。
- 用户名不支持设置为 admin 或 monitor，且实例内用户名称唯一。
StorageType string 可选 示例值：ESSD_PL0
- 对于峰值流量超过 100MB/s 的规格，应使用 ESSD_FlexPL。
- 创建实例后不支持修改存储类型，请谨慎选择。
IpWhiteList string[] 可选 示例值：{"acl-2e6694dd6ef3****","acl-4848ddb745fe49****"}
实例绑定的白名单 ID 列表。绑定白名单后，仅配置在白名单中的 IP 地址与地址段才能访问此实例。
若未设置此参数，新 Kafka 实例将绑定白名单 default，对应 IP 地址为 0.0.0.0，表示允许所有地址访问该 Kafka 实例。
Tags object 可选 示例值：{"testKey":"testVal"}
ChargeInfo object 必选 示例值：--
Kafka 实例的计费类型等计费信息。
ChargeType string 必选 示例值：PrePaid
实例的计费类型。支持的类型包括：
- PostPaid ：按量付费
- PrePaid：包年包月
说明
目前仅支持按量付费实例转为包年包月实例.
Period integer 可选 示例值：1
包年包月类型实例的购买时长。默认为 1。
- PeriodUnit 指定为 Month 时，取值范围为 1~9。
- PeriodUnit 指定为 Year 时，取值范围为 1~3。
- 仅包年包月类型的实例需要指定，即 ChargeType 指定为 PrePaid 时必选。
PeriodUnit string 可选 示例值：Month
包年包月类型实例的生命周期单位，即指定以月或以年为单位购买。支持设置为：
- Month：包月
- Year：包年
- 仅包年包月类型的实例需要指定，即 ChargeType 指定为 PrePaid 时必选。
AutoRenew boolean 可选 示例值：true
包年包月实例到期后是否自动续费。
- true：自动续费。
- false：（默认）不自动续费。到期后需要手动续费，否则实例将被关停。
- 仅包年包月类型的实例需要指定，即 ChargeType 指定为 PrePaid 时必选。
Parameters string 可选 示例值：{\"LogRetentionHours\":\"72\",\"MessageMaxByte\":\"10\",\"MessageTimestampType\":\"CreateTime\",\"OffsetRetentionMinutes\":\"4320\"}
Kafka 实例的初始参数配置。
通过 Postman 等方式调用 API 时，应注意转义，例如 {\"LogRetentionHours\":\"72\",\"MessageMaxByte\":\"10\",\"MessageTimestampType\":\"CreateTime\",\"OffsetRetentionMinutes\":\"4320\"}。
Parameters 参数说明
- "MessageMaxByte":"10"：最大消息大小。单位为MB，取值范围为1～12。默认为10。
- "LogRetentionHours":"72"：消息保留时长。单位为小时，取值范围为0～2160，即消息最久保留90天。默认为72。
- "OffsetRetentionMinutes":"4320"：消费位点保留时长。单位为分钟，取值范围为1～10080，即消费位点最久保留7天。默认为4320。
- "MessageTimestampType":"LogAppendTime"：消息时间类型，支持设置为LogAppendTime和CreateTime。LogAppendTime 表示消息写入到服务端的时间；CreateTime 表示Producer 创建消息的时间。
InstanceDescription string 可选 示例值：instance for test
Kafka 实例的简单描述。长度范围为 1~128 个字符。
InstanceName string 可选 示例值：Name123
Kafka 实例的名称。 需满足以下要求：
- 只能包含中文、字母、数字、下划线（_）和连字符（-）。
- 不能以数字和连字符（-）开头。
- 长度范围为 1~128 个字符。
说明
如果创建实例时未指定名称，则默认将实例ID作为实例名称。
EipId string 可选 示例值：eip-mjhulvqza6805smt1bnc****
EIP 的 ID。
说明
- 指定 EipId 表示开启实例的公网访问。
- EIP 提供独立的公网 IP 资源，包括公网 IP 地址与公网出口带宽服务。指定此参数开启公网访问后，公网地址将绑定您的弹性公网 IP（EIP），费用由 EIP 收取。
SubnetId string 必选 示例值：subnet-min6uy01kuf45smt1a2i****
实例所在的 VPC 子网 ID。
VpcId string 必选 示例值：vpc-13fo9gkz6j6683n6nu5ec****
实例所在的私有网络（VPC） ID。
说明
- 实例创建完成后，不可修改对应的私有网络和子网。创建实例时请谨慎操作。
- 您可以调用私有网络（VPC）的 DescribeVpcs 接口查询可用的 VPC 和子网列表。
StorageSpace integer 可选 示例值：1000
实例的存储空间。单位为 GiB，必须指定为 100 的倍数。
ComputeSpec string 必选 示例值：kafka.30xrate.hw
Version string 必选 示例值：2.2.2
支持的 Kafka 版本。当前支持的版本包括：
- 2.2.2：Kafka 2.2.2 版本。
- 2.8.2：Kafka 2.8.2 版本。
ClientToken string 可选 示例值：123e4567-e89b-12d3-a456-426655440000
保证客户端请求幂等性的标识。 该标识为 1~64 位的 ASCII 字符串，大小写敏感，由客户端生成，应确保不同请求之间该标识具有唯一性。
ProjectName string 可选 示例值：default
当前创建的 Kafka 实例所属的 IAM 项目。如果未指定 IAM 项目，消息队列 Kafka版会将新实例添加到名为 default 的 IAM 项目中。
返回参数
InstanceId string 示例值：kafka-cnngqkfgdudt****
Kafka 实例 ID。
OrderId string 示例值：order-712089661643355****
订单 ID。
请求示例
返回示例
错误码
最近更新时间：2025.10.15 10:34:21
这个页面对您有帮助吗？
有用
有用
无用
无用