# 创建实例（新规格） #### 功能介绍 创建实例。 ![](https://support.huaweicloud.com/api-kafka/public_sys-resources/note_3.0-zh-cn.png) 当前页面API为历史版本API，未来可能停止维护。请使用[创建实例](https://support.huaweicloud.com/api-kafka/CreatePostPaidKafkaInstance.html)。 #### URI POST /v2/{engine}/{project_id}/instances 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | engine | 是 | String | 消息引擎。 | | project_id | 是 | String | 项目ID，获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-kafka/kafka-api-0036212547.html)。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | 实例名称。 由英文字符开头，只能由英文字母、数字、中划线、下划线组成，长度为4\~64的字符。 | | description | 否 | String | 实例的描述信息。 长度不超过1024的字符串。 说明： \\与"在json报文中属于特殊字符，如果参数值中需要显示\\或者"字符，请在字符前增加转义字符\\，比如\\或者"。 | | engine | 是 | String | 消息引擎。取值填写为：kafka。 | | engine_version | 是 | String | 消息引擎的版本。 | | 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。 获取方法如下：参考[《虚拟私有云 API参考》](https://support.huaweicloud.com/api-vpc/vpc_apiv3_0003.html)，调用"查询VPC列表"接口，从响应体中获取VPC ID。 | | security_group_id | 是 | String | 指定实例所属的安全组。 获取方法如下：参考[《虚拟私有云 API参考》](https://support.huaweicloud.com/api-vpc/vpc_apiv3_0011.html)，调用"查询安全组列表"接口，从响应体中获取安全组ID。 | | subnet_id | 是 | String | 子网信息。 获取方法如下：参考[《虚拟私有云 API参考》](https://support.huaweicloud.com/api-vpc/vpc_subnet01_0003.html)，调用"查询子网列表"接口，从响应体中获取子网ID。 | | available_zones | 是 | Array of strings | 创建节点到指定且有资源的可用区ID。请参考[查询可用区信息](https://support.huaweicloud.com/api-kafka/ListAvailableZones.html)获取可用区ID。 该参数不能为空数组或者数组的值为空。 创建Kafka实例，支持节点部署在1个或3个及3个以上的可用区。在为节点指定可用区时，用逗号分隔开。 | | product_id | 是 | String | 产品ID。 产品ID可以从[查询产品规格列表](https://support.huaweicloud.com/api-kafka/ListEngineProducts.html)获取。 | | 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的磁盘类型。 如何选择磁盘类型请参考[《云硬盘 产品介绍》](https://support.huaweicloud.com/productdesc-evs/zh-cn_topic_0014580744.html)的"磁盘类型及性能介绍"。 | | enterprise_project_id | 否 | String | 企业项目ID。若为企业项目账号，该参数必填。 | | tags | 否 | Array of [TagEntity] objects | 标签列表。 | | arch_type | 否 | String | CPU架构。 取值范围： - X86 | | vpc_client_plain | 否 | Boolean | VPC内网明文访问。 | | bss_param | 否 | [BssParam] object | 表示包周期计费模式的相关参数。 如果为空，则默认计费模式为按需计费；否则是包周期方式。 | 表3TagEntity | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 否 | String | 标签键。 - 不能为空。 - 对于同一个实例，Key值唯一。 - 长度为1\~128个字符（中文也可以输入128个字符）。 - 由任意语种字母、数字、空格和字符组成，字符仅支持_ . : = + - @ - 首尾字符不能为空格。 | | value | 否 | String | 标签值。 - 长度为0\~255个字符（中文也可以输入255个字符）。 - 由任意语种字母、数字、空格和字符组成，字符仅支持_ . : = + - @ - 首尾字符不能为空格。 | 表4BssParam | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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时生效且为必选值。** | #### 响应参数 **状态码： 200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | instance_id | String | 实例ID | #### 请求示例 创建一个按需付费的Kafka实例，版本为2.7，规格为2U4G\*3，300GB的存储空间。 ``` POST https://{endpoint}/v2/{engine}/{project_id}/instances { "name" : "kafka-test", "description" : "", "engine" : "kafka", "engine_version" : "2.7,3.x", "storage_space" : 300, "vpc_id" : "********-9b4a-44c5-a964-************", "subnet_id" : "********-8fbf-4438-ba71-************", "security_group_id" : "********-e073-4aad-991f-************", "available_zones" : [ "********706d4c1fb0eb72f0********" ], "product_id" : "c6.2u4g.cluster", "ssl_enable" : true, "kafka_security_protocol" : "SASL_SSL", "sasl_enabled_mechanisms" : [ "SCRAM-SHA-512" ], "storage_spec_code" : "dms.physical.storage.ultra.v2", "broker_num" : 3, "arch_type" : "X86", "enterprise_project_id" : "0", "access_user" : "********", "password" : "********", "enable_publicip" : true, "tags" : [ { "key" : "aaa", "value" : "111" } ], "retention_policy" : "time_base", "disk_encrypted_enable" : true, "disk_encrypted_key" : "********-b953-4875-a743-************", "publicip_id" : "********-88fc-4a8c-86d0-************,********-16af-455d-8d54-************,********-3d69-4367-95ab-************", "vpc_client_plain" : true, "enable_auto_topic" : true } ``` #### 响应示例 **状态码： 200** 创建实例成功。 ``` { "instance_id" : "8959ab1c-7n1a-yyb1-a05t-93dfc361b32d" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 创建实例成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-kafka/ErrorCode.html)。