创建Kafka实例
功能介绍
使用API创建Kafka实例。
请求消息
请求参数
参数说明见表2。
参数 |
类型 |
是否必选 |
说明 |
---|---|---|---|
name |
String |
是 |
实例名称。 由英文字符开头,只能由英文字母、数字、中划线、下划线组成,长度为4~64的字符。 |
description |
String |
否 |
实例的描述信息。 长度不超过1024的字符串。
说明:
\与"在json报文中属于特殊字符,如果参数值中需要显示\或者"字符,请在字符前增加转义字符\,比如\\或者\"。 |
engine |
String |
是 |
消息引擎。取值填写为:kafka。 |
engine_version |
String |
是 |
消息引擎的版本。取值支持1.1.0和2.3.0。 |
specification |
String |
是 |
Kafka实例的基准带宽,表示单位时间内传送的最大数据量,单位MB。 取值范围为:
|
storage_space |
Integer |
是 |
消息存储空间,单位GB。
|
partition_num |
Integer |
是 |
Kafka实例的最大分区数量。
|
access_user |
String |
否 |
当ssl_enable为true时,该参数必选, ssl_enable为false时,该参数无效。 认证用户名,只能由英文字母、数字、中划线、下划线组成,长度为4~64的字符。 |
password |
String |
否 |
当ssl_enable为true时,该参数必选, ssl_enable为false时,该参数无效。 实例的认证密码。 复杂度要求:
|
vpc_id |
String |
是 |
虚拟私有云ID。 获取方法如下:
|
security_group_id |
String |
是 |
指定实例所属的安全组。 获取方法如下:
|
subnet_id |
String |
是 |
子网信息。 获取方法如下:
|
available_zones |
Array |
是 |
创建节点到指定且有资源的可用区ID。该参数不能为空数组或者数组的值为空,详情请参考查询可用区信息查询得到。在查询时,请注意查看该可用区是否有资源。 创建Kafka实例,支持节点部署在1个或3个及3个以上的可用区。在为节点指定可用区时,用逗号分隔开。 |
product_id |
String |
是 |
产品标识。 获取方法,请参考查询产品规格列表。 |
kafka_manager_user |
String |
是 |
表示登录Kafka Manager的用户名。只能由英文字母、数字、中划线、下划线组成,长度为4~64的字符。 |
kafka_manager_password |
String |
是 |
表示登录Kafka Manager的密码。 复杂度要求:
|
maintain_begin |
String |
否 |
维护时间窗开始时间,格式为HH:mm:ss。
|
maintain_end |
String |
否 |
维护时间窗结束时间,格式为HH:mm:ss。
|
ssl_enable |
Boolean |
否 |
是否打开SSL加密访问。
|
retention_policy |
String |
否 |
磁盘的容量到达容量阈值后,对于消息的处理策略。取值如下:
|
enable_auto_topic |
Boolean |
否 |
是否打开kafka自动创建topic功能。
当您选择开启,表示生产或消费一个未创建的Topic时,会自动创建一个包含3个分区和3个副本的Topic。 |
storage_spec_code |
String |
是 |
存储IO规格。 取值范围:
|
enterprise_project_id |
String |
否 |
企业项目ID。 |
tags |
Array<Object> |
否 |
标签列表。 |
参数 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
key |
String |
否 |
键。最大长度36个unicode字符。 key不能为空,不能为空字符串。 不能包含下列字符:非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。 |
value |
String |
否 |
值。每个值最大长度43个unicode字符。 value不能为空,可以空字符串。 不能包含下列字符:非打印字符ASCII(0-31), “=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。 |
{ "name": "kafka-test", "description": "", "engine": "kafka", "engine_version": "XXXX", "storage_space": 600, "access_user": "", "password": "", "kafka_manager_user": "******", "kafka_manager_password": "******", "vpc_id": "1e93f86e-13af-46c8-97d6-d40fa62b76c2", "security_group_id": "0aaa0033-bf7f-4c41-a6c2-18cd04cad2c8", "subnet_id": "b5fa806c-35e7-4299-b659-b39398dd4718", "available_zones": ["d573142f24894ef3bd3664de068b44b0"], "product_id": "00300-30308-0--0", "maintain_begin": "22:00:00", "maintain_end": "02:00:00", "ssl_enable": false, "enterprise_project_id": "0", "specification": "100MB", "partition_num": "300", "retention_policy": "produce_reject", "enable_auto_topic": true, "storage_spec_code": "dms.physical.storage.ultra" }