调用 CreateInstance 创建消息队列 Kafka版实例。
实例是消息队列 Kafka版服务的虚拟机资源,用于管理和存储 Topic、Group 等资源。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateInstance | 要执行的操作,取值:CreateInstance。 |
Version | String | 是 | 2022-05-01 | API的版本,取值:2022-05-01。 |
ZoneId | String | 是 | cn-beijing-a | 实例所在的可用区 ID。 |
UserPassword | String | 否 | Test@123456 | SASL/PLAIN 用户的密码。需要满足以下要求:
|
UserName | String | 否 | Test1 | SASL/PLAIN 用户名称。需要满足以下要求:
|
StorageType | String | 否 | ESSD_PL0 | Kafka 实例数据存储的云盘类型。可设置为 ESSD_FlexPL 或 ESSD_PL0,默认为 ESSD_FlexPL。关于不同存储类型的详细性能说明,请参考云盘规格。
|
IpWhiteList | Array of String | 否 | {"acl-2e6694dd6ef3****","acl-4848ddb745fe49****"} | 实例绑定的白名单 ID 列表。绑定白名单后,仅配置在白名单中的 IP 地址与地址段才能访问此实例。 |
Tags | Object | 否 | {"testKey":"testVal"} | 云资源标签。可以将实例通过标签进行归类,便于实例的搜索和资源聚合。详细说明请参考标签管理。 |
ChargeInfo | Object | 是 | -- | Kafka 实例的计费类型等计费信息。 |
Parameters | String | 否 | {"LogRetentionHours":"72","MessageMaxByte":"10","MessageTimestampType":"CreateTime","OffsetRetentionMinutes":"4320"} | Kafka 实例的初始参数配置。 Parameters 参数说明
|
InstanceDescription | String | 否 | instance for test | Kafka 实例的简单描述。长度范围为 1~128 个字符。 |
InstanceName | String | 否 | Name123 | Kafka 实例的名称。 需满足以下要求:
说明 如果创建实例时未指定名称,则默认将实例ID作为实例名称。 |
EipId | String | 否 | eip-mjhulvqza6805smt1bnc**** | EIP 的 ID。 说明
|
SubnetId | String | 是 | subnet-min6uy01kuf45smt1a2i**** | 实例所在的 VPC 子网 ID。 |
VpcId | String | 是 | vpc-13fo9gkz6j6683n6nu5ec**** | 实例所在的私有网络(VPC) ID。 说明
|
PartitionNumber | Integer | 否 | 1000 | |
StorageSpace | Integer | 否 | 1000 | 实例的存储空间。单位为 GiB,必须指定为 100 的倍数。 |
ComputeSpec | String | 是 | kafka.30xrate.hw | 实例的计算规格。您可以通过文档产品规格查看计算规格列表。 |
Version | String | 是 | 2.2.2 | 支持的 Kafka 版本。当前支持的版本包括:
|
ClientToken | String | 否 | 123e4567-e89b-12d3-a456-426655440000 | 保证客户端请求幂等性的标识。 该标识为 1~64 位的 ASCII 字符串,大小写敏感,由客户端生成,应确保不同请求之间该标识具有唯一性。 |
ProjectName | String | 否 | default | 当前创建的 Kafka 实例所属的 IAM 项目。如果未指定 IAM 项目,消息队列 Kafka版会将新实例添加到名为 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
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.30xrate.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****" } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
---|---|---|
400 | InvalidParameter.EipNumber | EIP数量不足。 |
400 | InvalidProject.NotFound | 该项目不存在。 |
400 | ResourceScaleSoldOut | %s可用区资源不足。 |
400 | ResourceAZSoldOut | %s可用区资源不足。 |
400 | InsufficientResource | 资源不足,无法执行该操作。 |
400 | QuotaExceeded.CreateInstance | 实例个数超过配额限制。 |
400 | OperationDenied.ResourceSoldOut | 当前可用区资源不足。 |
400 | InvalidInstance.AlreadyExists | 该实例已存在。 |
400 | Insufficient.Balance | 您的账户余额不足。 |
400 | Forbidden.Authentication | 账户未实名认证。 |
400 | InvalidParameter.Malformed | %s参数不符合规范。 |
400 | InvalidParameter.Unsupported | 不支持%s参数。 |
400 | InvalidParameter | 参数值无效。 |
400 | QuotaExceeded.InstanceNumber | 实例数量超出上限。 |
400 | QuotaExceeded.StorageCapacity | 所有实例的存储空间之和超出配额上限。 |
400 | InvalidParameter.StorageCapacity | 期望的存储空间不在计算规格指定的范围内。 |
400 | InstanceOrderCreateFailed | 创建订单失败。 |
400 | OperationDenied.ExistCreatingOrder | 已存在创建中的订单,无法执行该操作。 |
400 | OperationDenied.InsufficientIp | 所选子网IP数量不足,无法执行该操作。 |
400 | InvalidParameter.DiskType | DiskType 参数值无效。 |
403 | OperationDenied.AccountNotAuthorized | 您不具备相关权限 ,请授权或切换账号后重试。 |
404 | InvalidEip.NotFound | 该EIP不存在。 |
500 | InternalError | 内部错误,请稍后重试。 |