创建Kafka实例

project_id

String

是

项目ID。

name

String

是

实例名称。

由英文字符开头，只能由英文字母、数字、中划线、下划线组成，长度为4~64的字符。

description

String

否

实例的描述信息。

长度不超过1024的字符串。

说明：

\与"在json报文中属于特殊字符，如果参数值中需要显示\或者"字符，请在字符前增加转义字符\，比如\\或者\"。

engine

String

是

消息引擎。取值填写为：kafka。

engine_version

String

是

消息引擎的版本。

specification

String

是

Kafka实例的基准带宽，表示单位时间内传送的最大数据量，单位MB。

取值范围为：

• 100MB
• 300MB
• 600MB
• 1200MB

storage_space

Integer

是

消息存储空间，单位GB。

• Kafka实例规格为100MB时，存储空间取值范围600GB ~ 90000GB。
• Kafka实例规格为300MB时，存储空间取值范围1200GB ~ 90000GB。
• Kafka实例规格为600MB时，存储空间取值范围2400GB ~ 90000GB。
• Kafka实例规格为1200MB时，存储空间取值范围4800GB ~ 90000GB。

partition_num

Integer

是

Kafka实例的最大分区数量。

• 参数specification为100MB时，取值300
• 参数specification为300MB时，取值900
• 参数specification为600MB时，取值1800
• 参数specification为1200MB时，取值1800

access_user

String

否

当ssl_enable为true时，该参数必选， ssl_enable为false时，该参数无效。

认证用户名，只能由英文字母、数字、中划线、下划线组成，长度为4~64的字符。

password

String

否

当ssl_enable为true时，该参数必选， ssl_enable为false时，该参数无效。

实例的认证密码。

复杂度要求：

• 输入长度为8到32位的字符串。
• 必须包含如下四种字符中的三种组合：
  • 小写字母
  • 大写字母
  • 数字
  • 特殊字符包括（`~!@#$%^&*()-_=+\|[{}]:'",<.>/?）

vpc_id

String

是

虚拟私有云ID。

获取方法如下：

• 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。
• 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询VPC列表。

security_group_id

String

是

指定实例所属的安全组。

获取方法如下：

• 方法1：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组ID。
• 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询安全组列表。

subnet_id

String

是

子网信息。

获取方法如下：

• 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。
• 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表。

available_zones

Array

是

创建节点到指定且有资源的可用区ID。该参数不能为空数组或者数组的值为空，详情请参考查询可用区信息查询得到。在查询时，请注意查看该可用区是否有资源。

创建Kafka实例，支持节点部署在1个或3个及3个以上的可用区。在为节点指定可用区时，用逗号分隔开。参数设置参考如下示例。

• 一个可用区："available_zones": [ "a0865121f83b41cbafce65930a22a6e8" ]
• 三个及以上可用区："available_zones": ["a0865121f83b41cbafce65930a22a6e8","a0865121f83b41cbafce65930a22a6e7","a0865121f83b41cbafce65930a22a6e6"]

product_id

String

是

产品标识。

获取方法，请参考查询产品规格列表。

kafka_manager_user

String

是

表示登录Kafka Manager的用户名。只能由英文字母、数字、中划线、下划线组成，长度为4~64的字符。

kafka_manager_password

String

是

表示登录Kafka Manager的密码。

复杂度要求：

• 输入长度为8到32位的字符串。
• 必须包含如下四种字符中的三种组合：
  • 小写字母
  • 大写字母
  • 数字
  • 特殊字符包括（`~!@#$%^&*()-_=+\|[{}]:'",<.>/?）

maintain_begin

String

否

维护时间窗开始时间，格式为HH:mm:ss。

• 维护时间窗开始和结束时间必须为指定的时间段，可参考查询维护时间窗时间段获取。
• 开始时间必须为22:00:00、02:00:00、06:00:00、10:00:00、14:00:00和18:00:00。
• 该参数不能单独为空，若该值为空，则结束时间也为空。系统分配一个默认开始时间02:00:00。

maintain_end

String

否

维护时间窗结束时间，格式为HH:mm:ss。

• 维护时间窗开始和结束时间必须为指定的时间段，可参考查询维护时间窗时间段获取。
• 结束时间在开始时间基础上加四个小时，即当开始时间为22:00:00时，结束时间为02:00:00。
• 该参数不能单独为空，若该值为空，则开始时间也为空，系统分配一个默认结束时间06:00:00。

enable_publicip

Boolean

否

实例是否开启公网访问功能。

• true：开启
• false：不开启

public_bandwidth

String

否

表示公网带宽，单位是Mbit/s。

取值范围：

• Kafka实例规格为100MB时，公网带宽取值范围3到900，且必须为实例节点个数的倍数。
• Kafka实例规格为300MB时，公网带宽取值范围3到900，且必须为实例节点个数的倍数。
• Kafka实例规格为600MB时，公网带宽取值范围4到1200，且必须为实例节点个数的倍数。
• Kafka实例规格为1200MB时，公网带宽取值范围8到2400，且必须为实例节点个数的倍数。

publicip_id

String

否

实例绑定的弹性IP地址的ID。

以英文逗号隔开多个弹性IP地址的ID。

如果开启了公网访问功能（即enable_publicip为true），该字段为必选。

ssl_enable

Boolean

否

是否打开SSL加密访问。

• true：打开SSL加密访问。
• false：不打开SSL加密访问。

retention_policy

String

否

磁盘的容量到达容量阈值后，对于消息的处理策略。取值如下：

• time_base：自动删除
• produce_reject：生产受限

enable_auto_topic

Boolean

否

是否打开Kafka自动创建Topic功能。

• true：开启
• false：关闭

当您选择开启，表示生产或消费一个未创建的Topic时，会自动创建一个包含3个分区和3个副本的Topic。

storage_spec_code

String

是

存储IO规格。如何选择磁盘类型请参考磁盘类型及性能介绍。

取值范围：

• 参数specification为100MB时，取值dms.physical.storage.high或者dms.physical.storage.ultra
• 参数specification为300MB时，取值dms.physical.storage.high或者dms.physical.storage.ultra
• 参数specification为600MB时，取值dms.physical.storage.ultra
• 参数specification为1200MB时，取值dms.physical.storage.ultra

enterprise_project_id

String

否

企业项目ID。

tags

Array<Object>

否

标签列表。

key

String

否

键。最大长度36个unicode字符。

key不能为空，不能为空字符串。

不能包含下列字符：非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

value

String

否

值。每个值最大长度43个unicode字符。

value不能为空，可以空字符串。

不能包含下列字符：非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

instance_id

String

实例ID

200

创建实例成功。