调用CreateInstance创建消息队列 Kafka版实例。
实例是消息队列 Kafka版服务的虚拟机资源,用于管理和存储 Topic、Group 等资源。
参数 | 参数类型 | 是否必选 | 示例值 | 说明 |
---|---|---|---|---|
ZoneId | String | 是 | cn-beijing-a | 实例所在的可用区ID。 |
Version | String | 是 | 2.2.2 | 支持的Kafka版本。当前支持的版本包括:
|
ComputeSpec | String | 是 | kafka.20xrate.hw | 实例的计算规格。 |
VpcId | String | 是 | vpc-13fo9gkz6j6683n6nu5ec**** | 实例所在的 VPC ID。 说明
|
SubnetId | String | 是 | subnet-min6uy01kuf45smt1a2i**** | 实例所在的 VPC 子网 ID。 |
ChargeInfo | ChargeInfoObject | 是 | / | Kafka 实例的计费类型等计费信息。详细信息请参考数据结构文档中 ChargeInfoObject 部分。 |
UserName | String | 否 | Test1 | SASL/PLAIN 用户名称。应符合以下要求:
|
UserPassword | String | 否 | Test@123456 | SASL/PLAIN 用户的密码。应符合以下要求:
|
StorageSpace | Integer | 否 | 1000 | 实例的存储空间。 |
StorageType | String | 否 | ESSD_PL0 | Kafka 实例数据存储的云盘类型。可设置为 ESSD_FlexPL 或 ESSD_PL0,默认为 ESSD_FlexPL。关于不同存储类型的详细性能说明,请参考云盘规格。
|
PartitionNumber | Integer | 否 | 1000 | 分区数量。取值范围取决于当前指定的计算规格。 |
EipId | String | 否 | eip-mjhulvqza6805smt1bnc**** | EIP 的 ID。 说明
|
InstanceName | String | 否 | Name123 | Kafka 实例的名称。 应符合以下要求:
说明 如果创建实例时未指定名称,则默认将实例 ID 作为实例名称。 |
InstanceDescription | String | 否 | instance for test | Kafka 实例的简单描述。长度范围为 1~128 个字符。 |
Parameters | String | 否 | "{"MessageMaxByte": "10","LogRetentionHours": "72","OffsetRetentionMinutes": "4320"}" | Kafka 实例的初始参数配置。 |
ProjectName | String | 否 | newproject | 当前创建的 Kafka 实例所属的 IAM 项目。如果未指定 IAM 项目,消息队列 Kafka版会将新实例添加到名为 |
Tags | Map<String, String> | 否 | {"testKey":"testVal"} | 云资源标签。可以将实例通过标签进行归类,便于实例的搜索和资源聚合。详细说明请参考标签概述。 |
IpWhiteList | Array of String | 否 | {"acl-2e6694dd6ef3496c9a00aeaf56a7****","acl-4848ddb745fe49b3947c5dbdfbb6****"} | 实例绑定的白名单 ID 列表。绑定白名单后,仅配置在白名单中的 IP 地址与地址段才能访问此实例。若未设置此参数,新 Kafka 实例将绑定白名单 |
ClientToken | String | 否 | 123e4567-e89b-12d3-a456-426655440000 | 保证客户端请求幂等性的标识。 |
Parameters 参数说明
参数 | 参数类型 | 是否必选 | 示例值 | 说明 |
---|---|---|---|---|
MessageMaxByte | String | 否 | 12 | 最大消息大小。 |
LogRetentionHours | String | 否 | 2160 | 消息保留时长。 |
OffsetRetentionMinutes | String | 否 | 10080 | 消费位点保留时长。 |
MessageTimestampType | String | 否 | LogAppendTime | 消息时间类型,支持设置为:
|
AutoDeleteGroup | String | 否 | false | 是否自动删除 Group。默认为 false。
|
参数 | 参数类型 | 示例值 | 说明 |
---|---|---|---|
InstanceId | String | kafka-cnngqkfgdudt**** | Kafka 实例 ID。 |
OrderId | String | order-712089661643355**** | 订单 ID。 |
POST /?Action=CreateInstance&Version=2022-05-01 HTTP/1.1 Content-Type: application/json Host: kafka.volcengineapi.com X-Date: 20210328T100802Z Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/kafka/request, SignedHeaders=x-date, Signature=******** { "ZoneId": "cn-beijing-a", "Version": "2.2.2", "ComputeSpec": "kafka.20xrate.hw", "VpcId": "vpc-rs4yccs57e9sv0x57bf****", "SubnetId": "subnet-rrps5hvr1bswv0x58fp****", "UserName": "kafka2001", "UserPassword":"Test@123456", "ChargeInfo": { "ChargeType": "PrePaid", "AutoRenew": true, "PeriodUnit": "Month", "Period": 1 } }
{ "ResponseMetadata": { "RequestId": "202302271904532FE25613615E5671AB07", "Action": "CreateInstance", "Version": "2022-05-01", "Service": "Kafka", "Region": "cn-beijing" }, "Result": { "InstanceId": "kafka-cnngbnntswg1****", "OrderId": "Order720478931462498****" } }