tencentcloud_ckafka_instance

最近更新时间:2025-09-04 14:56:12

我的收藏

描述

CKafka 实例,产品介绍

示例

variable "vpc_id" {
default = "vpc-nnk6bcjt"
}

variable "subnet_id" {
default = "subnet-ha2x63qo"
}

# 预付费实例
resource "tencentcloud_ckafka_instance" "kafka_instance_prepaid" {
instance_name = "ckafka-instance-prepaid"
zone_id = 100006
period = 1
vpc_id = var.vpc_id
subnet_id = var.subnet_id
msg_retention_time = 1300
renew_flag = 0
kafka_version = "2.8.1"
disk_size = 200
disk_type = "CLOUD_BASIC"
band_width = 20
partition = 400

instance_type = 1
specifications_type = "profession"

config {
auto_create_topic_enable = true
default_num_partitions = 3
default_replication_factor = 3
}

dynamic_retention_config {
enable = 1
}
}

# 后付费实例
resource "tencentcloud_ckafka_instance" "kafka_instance_postpaid" {
instance_name = "ckafka-instance-postpaid"
zone_id = 100006
vpc_id = var.vpc_id
subnet_id = var.subnet_id
msg_retention_time = 1300
kafka_version = "2.8.1"
disk_size = 200
band_width = 20
disk_type = "CLOUD_BASIC"
partition = 400
charge_type = "POSTPAID_BY_HOUR"

config {
auto_create_topic_enable = true
default_num_partitions = 3
default_replication_factor = 3
}

dynamic_retention_config {
enable = 1
}
}

参数说明

类型
名称
数据类型
说明
必填
region
string
地域,如:ap-guangzhou,默认使用 provider 中定义的 region 也可以在 resource 中指定地域,覆盖默认设置
instance_name
string
实例名称,是一个不超过 64 个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)
zone_id
int
实例所在的可用区 ID。当创建多可用区实例时,该参数为创建的默认接入点所在子网的可用区 ID
可选
availability_zone
string
可用区
count
int
资源数量,默认为 1 如果为 0 则不创建资源
activity_id
int
计费活动 ID,保留字段
band_width
int
实例内网峰值带宽。单位 MB/s。标准版需传入当前实例规格所对应的峰值带宽。注意如果创建的实例为专业版实例,峰值带宽,分区数等参数配置需要满足专业版的计费规格。
charge_type
enum
计费方式
枚举值:
PREPAID:预付费
POSTPAID_BY_HOUR:按量付费
config
Schema[]
实例配置
Schema 类型详见:ConfigSchema
disk_size
int
实例硬盘大小,需要满足当前实例的计费规格
disk_type
string
专业版实例磁盘类型,标准版实例不需要填写。
"CLOUD_SSD":SSD云硬盘
"CLOUD_BASIC":高性能云硬盘
不传默认值为 "CLOUD_BASIC"
dynamic_retention_config
Schema[]
动态消息保留策略配置
Schema 类型详见:DynamicRetentionConfigSchema
instance_type
int
国际站标准版实例规格。目前只有国际站标准版使用当前字段区分规格,国内站标准版使用峰值带宽区分规格。除了国际站标准版外的所有实例填写 1 即可。
国际站标准版实例:
[入门型(general)]填写1;
[标准型(standard)]填写2;
[进阶型(advanced)]填写3;
[容量型(capacity)]填写4;
[高阶型1(specialized-1)]填写5;
[高阶型2(specialized-2)]填写6;
[高阶型3(specialized-3)]填写7;
[高阶型4(specialized-4)]填写8。
kafka_version
string
实例版本。目前支持"0.10.2","1.1.1","2.4.1","2.4.2","2.8.1"。
"2.4.1" 与 "2.4.2" 属于同一个版本,传任意一个均可
max_message_byte
int
实例级别单条消息大小(单位byte)
msg_retention_time
int
可选。实例日志的最长保留时间,单位分钟,默认为10080(7天),最大30天,不填默认0,代表不开启日志保留时间回收策略
multi_zone_flag
boolean
当前实例是否为多可用区实例
zone_ids
int[]
当实例为多可用区实例时,多可用区 ID 列表。注意参数 ZoneId 对应的多可用区需要包含在该参数数组中
示例值:[100006,100007]
partition
int
实例最大分区数量,需要满足当前实例的计费规格
period
int
预付费购买时长,例如 "1",就是一个月
public_network
int
公网带宽
rebalance_time
int
升配 Rebalance 时间
renew_flag
int
预付费自动续费标记,0表示默认状态(用户未设置,即初始状态), 1表示自动续费,2表示明确不自动续费(用户设置)
specifications_type
enum
实例类型
枚举值:
standard:标准版
profession:专业版
premium:高级版,按量计费暂不支持高级版实例
vpc_id
string
创建的实例默认接入点所在的 VPC 对应 vpcId。目前不支持创建基础网络实例,因此该参数必填
subnet_id
string
子网 ID。创建实例默认接入点所在的子网对应的子网 ID
生成
id
string
资源实例 ID
create_time
string
资源创建时间

数据结构

ConfigSchema

参数说明

类型
名称
数据类型
说明
必填
auto_create_topic_enable
boolean
自动创建 true 表示开启,false 表示不开启
default_num_partitions
int
可选,如果 auto.create.topic.enable 设置为 true 没有设置该值时,默认设置为3
default_replication_factor
int
如果 auto.create.topic.enable 设置为 true 没有指定该值时默认设置为2

DynamicRetentionConfigSchema

参数说明

类型
名称
数据类型
说明
必填
bottom_retention
int
保底时长,单位分钟
disk_quota_percentage
int
磁盘配额百分比触发条件,即消息达到此值触发消息保留时间变更事件
enable
int
动态消息保留时间配置开关(0: 关闭,1: 开启)
step_forward_percentage
int
每次向前调整消息保留时间百分比