# 创建Kafka实例 ![](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 /v1.0/{project_id}/instances 参数说明见[表1]。 表1参数说明 | 参数 | 类型 | 必选 | 说明 | |:---|:---|:---|:---| | project_id | String | 是 | 项目ID。 | #### 请求消息 **请求参数** 参数说明见[表2]。 表2参数说明 | 参数 | 类型 | 是否必选 | 说明 | |:---|:---|:---|:---| | 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。 获取方法如下：参考[《虚拟私有云 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 | 是 | 创建节点到指定且有资源的可用区ID。该参数不能为空数组或者数组的值为空，详情请参考[查询可用区信息](https://support.huaweicloud.com/api-kafka/kafka-api-180514008.html)查询得到。在查询时，请注意查看该可用区是否有资源。 创建Kafka实例，支持节点部署在1个或3个及3个以上的可用区。在为节点指定可用区时，用逗号分隔开。参数设置参考如下示例。 - 一个可用区："available_zones": \[ "a0865121f83b41cbafce65930a22a6e8" \] - 三个及以上可用区："available_zones": \["a0865121f83b41cbafce65930a22a6e8","a0865121f83b41cbafce65930a22a6e7","a0865121f83b41cbafce65930a22a6e6"\] | | product_id | String | 是 | 产品标识。 获取方法，请参考[查询产品规格列表](https://support.huaweicloud.com/api-kafka/kafka-api-180514009.html)。 | | kafka_manager_user | String | 是 | 表示登录Kafka Manager的用户名。只能由英文字母、数字、中划线、下划线组成，长度为4\~64的字符。 | | kafka_manager_password | String | 是 | 表示登录Kafka Manager的密码。 复杂度要求： - 输入长度为8到32位的字符串。 - 必须包含如下四种字符中的三种组合： - 小写字母 - 大写字母 - 数字 - 特殊字符包括（\`\~!@#$%\^\&\*()-_=+\\\|\[{}\]:'",\<.\>/?） | | maintain_begin | String | 否 | 维护时间窗开始时间，格式为HH:mm:ss。 - 维护时间窗开始和结束时间必须为指定的时间段，可参考[查询维护时间窗时间段](https://support.huaweicloud.com/api-kafka/kafka-api-180514010.html)获取。 - 开始时间必须为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。 - 维护时间窗开始和结束时间必须为指定的时间段，可参考[查询维护时间窗时间段](https://support.huaweicloud.com/api-kafka/kafka-api-180514010.html)获取。 - 结束时间在开始时间基础上加四个小时，即当开始时间为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：生产受限 | | connector_enable | Boolean | 否 | 表示是否开启转储开关。 | | enable_auto_topic | Boolean | 否 | 是否打开Kafka自动创建Topic功能。 - true：开启 - false：关闭 当您选择开启，表示生产或消费一个未创建的Topic时，会自动创建一个包含3个分区和3个副本的Topic。 | | storage_spec_code | String | 是 | 存储IO规格。如何选择磁盘类型请参考[磁盘类型及性能介绍](https://support.huaweicloud.com/productdesc-evs/zh-cn_topic_0044524691.html)。 取值范围： - 参数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\ | 否 | 标签列表。 | 表3tags | 参数 | 参数类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | key | String | 否 | 键。最大长度36个unicode字符。 key不能为空，不能为空字符串。 不能包含下列字符：非打印字符ASCII(0-31)，"=","\*","\<","\>","\\",",","\|","/"。 | | value | String | 否 | 值。每个值最大长度43个unicode字符。 value不能为空，可以为空字符串。 不能包含下列字符：非打印字符ASCII(0-31)，"=","\*","\<","\>","\\",",","\|","/"。 | ``` { "name": "kafka-test", "engine": "kafka", "engine_version": "xxxx", "specification": "100MB", "storage_space": 600, "partition_num": 300, "vpc_id": "b50c1aa7-39e0-420e-936b-ee5d35288f9c", "security_group_id": "d8c81e0f-de6a-4110-8c96-81af3eacb3d1", "subnet_id": "0b6cfaea-bce7-48eb-b38d-267c24df5f79", "available_zones": [ "38b0f7a602344246bcb0da47b5d548e7" ], "product_id": "00300-30308-0--0", "kafka_manager_user": "test", "kafka_manager_password": "Zxxxx", "enable_publicip": true, "publicip_id": "87864b85-7097-4c06-9d62-718d7359a503,72c12ba7-fade-4b06-a680-01d335cf786d,11b535df-ed6d-4521-8d00-12bb60beb617", "storage_spec_code": "dms.physical.storage.high" } ``` #### 响应消息 **响应参数** 参数说明见[表4]。 表4参数说明 | 参数 | 类型 | 说明 | |:---|:---|:---| | instance_id | String | 实例ID | **响应示例** ``` { "instance_id": "8959ab1c-7n1a-yyb1-a05t-93dfc361b32d" } ``` #### 状态码 操作成功的状态码如[表5]所示，其他响应见[状态码](https://support.huaweicloud.com/api-kafka/kafka-api-0034672261.html)。 表5状态码 | 状态码 | 描述 | |:---|:---| | 200 | 创建实例成功。 |