创建实例

engine

是

String

消息引擎。

project_id

是

String

项目ID，获取方式请参见获取项目ID。

name

是

String

实例名称。

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

description

否

String

实例的描述信息。

长度不超过1024的字符串。

说明：

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

engine

是

String

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

engine_version

是

String

消息引擎的版本。取值填写为：

• 1.1.0
• 2.3.0
• 2.7
• 3.x

broker_num

是

Integer

代理个数。

storage_space

是

Integer

消息存储空间，单位GB。

• Kafka实例规格为c6.2u4g.cluster时，存储空间取值范围300GB ~ 300000GB。
• Kafka实例规格为c6.4u8g.cluster时，存储空间取值范围300GB ~ 600000GB。
• Kafka实例规格为c6.8u16g.cluster时，存储空间取值范围300GB ~ 1500000GB。
• Kafka实例规格为c6.12u24g.cluster时，存储空间取值范围300GB ~ 1500000GB。
• Kafka实例规格为c6.16u32g.cluster时，存储空间取值范围300GB ~ 1500000GB。

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。

获取方法如下：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。

security_group_id

是

String

指定实例所属的安全组。

获取方法如下：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组ID。

subnet_id

是

String

子网信息。

获取方法如下：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。

available_zones

是

Array of strings

创建节点到指定且有资源的可用区ID。请参考查询可用区信息获取可用区ID。

该参数不能为空数组或者数组的值为空。

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

product_id

是

String

产品ID。

产品ID可以从查询产品规格列表获取。

maintain_begin

否

String

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

maintain_end

否

String

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

enable_publicip

否

Boolean

是否开启公网访问功能。默认不开启公网。

• true：开启
• false：不开启

publicip_id

否

String

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

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

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

ssl_enable

否

Boolean

是否打开SSL加密访问。

实例创建后将不支持动态开启和关闭。

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

kafka_security_protocol

否

String

开启SASL后使用的安全协议，如果开启了SASL认证功能（即ssl_enable=true），该字段为必选。

若该字段值为空，默认开启SASL_SSL认证机制。

实例创建后将不支持动态开启和关闭。

• SASL_SSL: 采用SSL证书进行加密传输，支持账号密码认证，安全性更高。
• SASL_PLAINTEXT: 明文传输，支持账号密码认证，性能更好，建议使用SCRAM-SHA-512机制。

sasl_enabled_mechanisms

否

Array of strings

开启SASL后使用的认证机制，如果开启了SASL认证功能（即ssl_enable=true），该字段为必选。

若该字段值为空，默认开启PLAIN认证机制。

选择其一进行SASL认证即可，支持同时开启两种认证机制。

取值如下：

• PLAIN: 简单的用户名密码校验。
• SCRAM-SHA-512: 用户凭证校验，安全性比PLAIN机制更高。

retention_policy

否

String

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

取值如下：

• produce_reject：表示拒绝消息写入。
• time_base：表示自动删除最老消息。

ipv6_enable

否

Boolean

是否开启ipv6。仅在虚拟私有云支持ipv6时生效。

disk_encrypted_enable

否

Boolean

是否开启磁盘加密。

disk_encrypted_key

否

String

磁盘加密key，未开启磁盘加密时为空

enable_auto_topic

否

Boolean

是否打开kafka自动创建topic功能。

• true：开启
• false：关闭

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

默认是false关闭。

storage_spec_code

是

String

存储IO规格。

取值范围：

• dms.physical.storage.high.v2：使用高IO的磁盘类型。
• dms.physical.storage.ultra.v2：使用超高IO的磁盘类型。

如何选择磁盘类型请参考《云硬盘 用户指南》的“磁盘类型及性能介绍”。

enterprise_project_id

否

String

企业项目ID。若为企业项目账号，该参数必填。

tags

否

Array of TagEntity objects

标签列表。

arch_type

否

String

CPU架构。

取值范围：

• X86

vpc_client_plain

否

Boolean

VPC内网明文访问。

bss_param

否

BssParam object

表示包周期计费模式的相关参数。

如果为空，则默认计费模式为按需计费；否则是包周期方式。

key

否

String

标签键。

• 不能为空。
• 对于同一个实例，Key值唯一。
• 长度为1~128个字符（中文也可以输入128个字符）。
• 由任意语种字母、数字、空格和字符组成，字符仅支持_ . : = + - @
• 首尾字符不能为空格。

value

否

String

标签值。

• 长度为0~255个字符（中文也可以输入255个字符）。
• 由任意语种字母、数字、空格和字符组成，字符仅支持_ . : = + - @
• 首尾字符不能为空格。

is_auto_renew

否

Boolean

是否自动续订。

取值范围：

• true: 自动续订。
• false: 不自动续订。

默认不自动续订。

charging_mode

否

String

计费模式。

取值范围：

• prePaid：预付费，即包年包月；
• postPaid：后付费，即按需付费；

默认为postPaid。

is_auto_pay

否

Boolean

下单订购后，是否自动从客户的账户中支付，而不需要客户手动去进行支付。

取值范围：

• true：是（自动支付）
• false：否（需要客户手动支付）

默认为手动支付。

period_type

否

String

订购周期类型。

取值范围：

• month：月
• year：年

chargingMode为prePaid时生效且为必选值。

period_num

否

Integer

订购周期数。

取值范围：

• periodType=month（周期类型为月）时，取值为[1，9]；
• periodType=year（周期类型为年）时，取值为[1，3]；

chargingMode为prePaid时生效且为必选值。

instance_id

String

实例ID

200

创建实例成功。