文档中心

CreateKafkaInstance

最近更新时间：2023.03.01 19:51:21

首次发布时间：2021.08.30 16:20:21

调用 CreateKafkaInstance 接口创建 Kafka 实例。

使用说明

实例是消息队列 Kafka版服务的虚拟机资源，用于管理和存储 Topic、Group 等资源。

此接口的 API Version 为 2018-01-01。
此接口的调用频率限制为 20 次/s，超出频率限制会报错“AccountFlowLimitExceeded”。

说明

通过 API 创建接口时暂不支持同时开启公网访问功能，如果需要开启实例的公网访问，建议在创建实例完成后，实例状态为运行中（Running）时，调用 EnableInternetAccess 开启实例的公网访问。
默认情况下，您可以在每个地域中创建 5 个 Kafka 实例，每个账号在每个地域中的所有实例存储容量总和最大为 10TiB，否则创建实例时报错 “The instance_num/storage_sum has exceeded quota”。如需提高配额，请在配额中心提交申请，例如申请提高每个地域下的最大实例数量（InstanceNum），最高可调整至 10 个。

请求参数

参数	参数类型	是否必选	示例值	说明
ZoneId	String	必选	cn-beijing-a	实例所在的可用区。消息队列 Kafka版支持多可用区部署 Kafka 实例，对于 3 个及以上可用区的地域，您可以通过指定 3 个可用区的方式实现跨可用区部署。多个可用区之间通过英文逗号（,）分隔，例如 `cn-guangzhou-a,cn-guangzhou-b`。说明多可用区部署为华东1（广州）地域的邀测功能，若有相关业务需求，请通过工单系统联系技术支持申请白名单。
KafkaSpecification	String	必选	kafka.n3.x2.small	计算规格。当前支持的计算规格请参考产品规格。
DiskCapacity	Integer	必选	1500	存储空间大小，单位为 GiB，步长为 300。您可以查看产品规格文档，获取计算规格和存储空间的详细信息。
NetTypes	List	必选	[ "Private" ],	实例的网络类型。支持的值包括： Private：（必选）私有网络 VPC 访问。设置开启 VPC 访问时，您需要通过 VpcId 和 SubnetId 指定实例对应的 VPC 和子网。
VpcInfo	VPCInfo	必选		VPC 相关信息，详情请参见 VPCInfo。
Users	String	必选	test	Kafka 实例使用 PLAIN 模式的用户名称。
Passwords	String	必选	xxxxiiiiiixxx	Kafka 实例使用 PLAIN 模式的用户密码。
ChargeInfo	JSON Array	必选		实例的计费信息。详细信息请参考 CreateChargeInfo。
Region	String	可选	cn-beijing	实例所在的 Region。不支持跨 Region 调用，此参数指定的值需要和 header 中的 Region 相同。
InstanceName	String	可选	kafka	Kafka 实例名称。需满足以下要求：只能包含中文、英文字母、数字、下划线（_）和连字符（-）。不能以数字或连字符（-）开头。长度为 0～128 字符。未设置 Kafka 实例名称时，将用实例 ID 作为实例名称。
Description	String	可选	Instance Description	实例的描述信息。
Params	List	可选		Kafka 实例的相关参数。详细信息请参考 UpdateInstanceParamItem。
ProjectName	String	可选	kafka-project	实例所属的 IAM 项目。默认情况下，消息队列 Kafka版不会将实例添加到任何 IAM 项目中。

响应参数

参数	参数类型	示例	说明
InstanceID	String	kafka-cndvg8bj1q67****	实例 ID。
OrderId	String	order-dvsgsgg8****	订单 ID。

示例

请求示例

POST https://kafka.volcengineapi.com/?Action=CreateKafkaInstance&Version=2018-01-01 HTTP/1.1
Accept: application/json
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=********

{
  "Region": "cn-beijing",
  "VpcInfo": {
    "ID": "vpc-testtesttest",
    "Name": "kafka-test",
    "SubnetId": "subnet-xxxxxxxxxx"
   },
  "DiskCapacity": 1500,
  "KafkaSpecification": "kafka.n3.x2.small",
  "NetTypes": [
    "Private"
  ],
  "InstanceName": "kafka-****",
  "ZoneId": "cn-beijing-a",
  "Description": "kafka的描述信息",
  "Users": "test",
  "Passwords": "xxxxiiiiiixxx",
  "Params": [
    {
      "Name": "max_byte",
      "RunningValue": "1"
    }
  ],
  "ChargeInfo": {
    "ChargeType": "PostPaid",
    "ChargeSubType": "Monthly",
    "ChargeUnitNum": 1,
    "AutoReNew": false
  },
  "ProjectName": "kafka-project"
}

响应示例

{
  "ResponseMetadata": {
    "RequestId": "****************",
    "Action": "CreateKafkaInstance",
    "Version": "2018-01-01",
    "Service": "kafka",
    "Region": "cn-beijing"
  },
  "Result": {
    "InstanceID": "kafka-cndvg8bj1q67****",
    "OrderId": "order-*******"
  }
}

使用说明

请求参数

响应参数

示例

请求示例

响应示例