文档中心
登录
注册
消息队列 Kafka版
文档指南
消息队列 Kafka版
消息队列 Kafka版
文档指南
请输入
产品动态
新功能发布记录
产品公告
消息队列 Kafka版正式商用通知
计算规格名称调整说明
产品介绍
什么是消息队列 Kafka版
产品优势
产品功能
产品规格
相关概念
地域及可用区
限制说明
消息队列|MQ
产品计费
计费概述
计费项
计费类型
按量计费
包年包月
转包年包月
实例续费
欠费或到期说明
退订或变配费用说明
税费及发票
快速入门
概述
准备环境
创建资源
连接实例
使用 PLAINTEXT 接入点连接实例
使用 SASL_PLAINTEXT 接入点连接实例
使用 SASL_SSL 接入点连接实例
使用 SSL 接入点连接实例
用户指南
实例管理
实例生命周期管理
创建实例
查看实例详情
升级实例规格
删除实例
重启实例
连接管理
添加接入点
查看接入点
配置公网访问
设置公网解析
删除接入点
实例运维
修改参数配置
查看节点信息
设置磁盘清理水位
操作审计
实例标签管理
实例标签概述
绑定标签
根据标签筛选实例
编辑和解绑标签
Topic 管理
创建 Topic
批量导入 Topic
导出 Topic 列表
修改 Topic 配置
管理 Topic 标签
查看 Topic 详情
删除 Topic
在线调试
限流管理
添加限流
修改限流
删除限流
Group 管理
创建 Group
批量导入 Group
导出 Group 列表
管理 Group 标签
查看 Group 详情
重置消费位点
删除 Group
消息查询
用户管理
创建 SASL 用户
批量导入 SASL 用户
重置 SASL 用户密码
查看 PLAIN 用户密码
删除 SASL 用户
ACL 管理
创建 ACL
删除 ACL
后台任务管理
监控告警
查看监控数据
设置告警规则
推荐配置的告警规则
访问控制
基于 IAM 管理权限
可授权的资源和操作
跨服务访问
访问策略模板
白名单管理
创建白名单
为白名单绑定实例
为白名单解绑实例
查看白名单信息
修改白名单
删除白名单
集群迁移
集群迁移概述
创建迁移任务
迁移元数据
在线迁移元数据
离线迁移元数据
导入元数据
修改迁移数据配置
查看迁移命令
删除迁移任务
Kafka Agent
Kafka Agent 概述
使用 Kafka Agent
API 参考
API 版本说明
V2(2022-05-01)
使用前必读
API 概览
如何调用 API
请求结构
服务地址
签名机制
返回结果
公共参数
资源检查
DescribeRegions - 查看地域列表
DescribeAvailabilityZones - 查看可用区列表
实例管理
CreateInstance - 创建实例
DescribeInstances - 查看实例列表
DescribeInstanceDetail - 查看实例详情
DeleteInstance - 删除实例
ModifyInstanceAttributes - 修改实例基本信息
ModifyInstanceSpec - 变更实例规格
ModifyInstanceParameters - 修改实例参数
ModifyInstanceChargeType - 变更实例的计费类型
网络管理
CreatePublicAddress - 开启公网访问
DeletePublicAddress - 关闭公网访问
Topic 管理
CreateTopic - 创建 Topic
DeleteTopic - 删除 Topic
ModifyTopicAttributes - 修改 Topic 描述
ModifyTopicParameters - 修改 Topic 参数配置
ModifyTopicAccessPolicies - 修改 Topic 的用户权限
DescribeTopics - 查看 Topic 列表
DescribeTopicParameters - 查看 Topic 的参数配置
DescribeTopicPartitions - 查看 Topic 分区
DescribeTopicAccessPolicies - 查看 Topic 的权限列表
Group 管理
CreateGroup - 创建Group
ModifyGroup - 更新消费组
DeleteGroup - 删除 Group
DescribeGroups - 查看 Group 列表
DescribeConsumedTopics - 查看 Group 订阅的 Topic
DescribeConsumedPartitions - 查看 Group 订阅的分区
ResetConsumedOffsets - 重置消费位点
消息查询
QueryMessageByTimestamp - 根据时间查询消息
SASL 用户管理
CreateUser - 创建 SASL 用户
DeleteUser - 删除 SASL 用户
ModifyUserAuthority - 更改 SASL 用户默认权限
DescribeUsers - 查看 SASL 用户列表
ACL策略管理
CreateAcl - 创建ACL策略
DescribeAcls - 查询ACL策略
DeleteAcl - 删除ACL策略
操作审计
DescribeTopicAuditInfo - 查询主题审计信息
标签管理
AddTagsToResource - 添加实例标签
RemoveTagsFromResource - 解绑实例标签
DescribeTagsByResource - 查询实例标签
白名单管理
CreateAllowList - 新建白名单
ModifyAllowList - 修改白名单
DeleteAllowList - 删除白名单
DescribeAllowLists - 查询白名单列表
DescribeAllowListDetail - 查询白名单详情
AssociateAllowList - 绑定白名单
DisassociateAllowList - 解绑白名单
附录
请求幂等性
V1(2018-01-01)
使用前必读
如何调用 API
请求结构
服务地址
签名机制
返回结果
公共参数
API 概览
实例管理
ListKafkaConf
CreateKafkaInstance
DeleteKafkaInstance
DescribeInstanceDetail
DescribeInstancesSummary
ModifyInstanceDescription
ModifyInstanceName
ModifyInstanceParams
ModifyChargeToPrepaid
ScaleKafkaInstance
EnableInternetAccess
DisableInternetAccess
Topic 管理
CreateTopic
DeleteTopic
DescribeTopics
DescribeTopicAuthorities
DescribeTopicPartitions
ModifyTopic
ModifyTopicAuthorities
QueryMessageByMessageId
Group 管理
DeleteGroup
DescribeConsumedPartitions
DescribeConsumedTopics
DescribeGroups
ResetConsumedOffsets
SASL 用户管理
CreateSaslUser
DescribeSaslUsers
DeleteSaslUser
ModifySaslPassword
ModifyUserAuthority
附录
数据结构
错误码
SDK 参考
概述
Apache Kafka SDK
Java 客户端 SDK
概述
准备工作
PLAINTEXT 接入点收发消息
SASL_PLAINTEXT 接入点 PLAIN 机制收发消息
SASL_PLAINTEXT 接入点 SCRAM 机制收发消息
SASL_SSL 接入点 PLAIN 机制收发消息
SASL_SSL 接入点 SCRAM 机制收发消息
配置文件
Go 客户端 SDK
概述
准备工作
PLAINTEXT 接入点收发消息
SASL_PLAINTEXT 接入点 PLAIN 机制收发消息
SASL_PLAINTEXT 接入点 SCRAM 机制收发消息
SASL_SSL 接入点 PLAIN 机制收发消息
SASL_SSL 接入点 SCRAM 机制收发消息
SDK 配置说明
Python 客户端 SDK
概述
准备工作
PLAINTEXT 接入点收发消息
SASL_PLAINTEXT 接入点 PLAIN 机制收发消息
SASL_PLAINTEXT 接入点 SCRAM 机制收发消息
SASL_SSL 接入点 PLAIN 机制收发消息
SASL_SSL 接入点 SCRAM 机制收发消息
SDK 配置说明
C++ 客户端 SDK
概述
准备工作
PLAINTEXT 接入点收发消息
SASL_PLAINTEXT 接入点 PLAIN 机制收发消息
SASL_PLAINTEXT 接入点 SCRAM 机制收发消息
SASL_SSL 接入点 PLAIN 机制收发消息
SASL_SSL 接入点 SCRAM 机制收发消息
Volcengine SDK
概述
Volcengine Go SDK
Go SDK 概述
安装 Go SDK
快速开始
Volcengine Python SDK
Python SDK 概述
安装 Python SDK
快速开始
Volcengine Java SDK
Java SDK 概述
安装 Java SDK
快速开始
最佳实践
Kafka 业务迁移
迁移概述
Kafka 迁移上云(方案一)
Kafka 迁移上云(方案二)
查看迁移进度和结果
Topic 使用建议
Kafka 生产者最佳实践
Kafka 消费者最佳实践
消息顺序性与可靠性
Kafka 集群数据均衡
多可用区部署 Kafka 实例
Kafka CPU 消耗场景分析
接入 Filebeat
通过函数服务消费消息队列 Kafka 版
对 Kafka 进行生产和消费压力测试
概述
使用 PLAINTEXT 接入点进行压力测试
使用 SASL_PLAINTEXT 接入点进行压力测试
使用 SASL_SSL 接入点进行压力测试
数据压缩算法推荐
常见问题
实例配置FAQ
实例连接FAQ
Topic和Group管理FAQ
资源与成本管理FAQ
消息收发与存储FAQ
相关协议
产品和服务测试协议
中间件产品服务条款
消息队列服务等级协议(SLA)
文档首页
消息队列 Kafka版
产品介绍
产品功能
复制全文
下载 pdf
我的收藏
产品介绍
产品功能
复制全文
下载 pdf
我的收藏
产品功能
文档反馈
问问助手
实例管理
功能
说明
实例管理
支持实例级别的资源管理,即创建实例、查看实例信息、删除实例等。详细说明请参考
创建实例
、
查看实例详情
。
提供多种实例规格,并支持升降配。升降配时可自定义再均衡(Rebalance)执行时间,避开业务高峰。升配详细说明请参考
升级实例规格
,降配功能暂时处于邀测阶段,如需使用,请联系客户经理开通白名单。
VPC与
公网访问
Kafka 实例支持 VPC 与公网访问方式,满足不同场景下的访问需求。
基于不同的访问方式,消息队列 Kafka版提供多种接入点供您使用。
参数管理
消息队列 Kafka版在实例与 Topic 级别均提供了部分参数的在线可视化配置,指定不同场景下的各种消息策略,例如通过
消息保留时长
配置
消息过期删除策略
、参数
磁盘清理水位
配置
磁盘容量阈值策略
等等。
后台任务管理
提供后台任务的执行记录,展示实例更配、重启等后台任务的执行状态、详情、开始与结束时间等信息。
白名单管理
支持白名单管理,为实例绑定白名单之后,仅白名单中的 IP 地址才能访问实例。
添加限流
支持 Topic 级别的流控管理,包括添加限流、修改限流以及删除限流配置。避免因单个 Topic 流量过大而影响其他 Topic 或整个 Kafka 集群性能。
Group和Topic管理
功能
说明
Topic 管理
支持 Topic 级别的资源管理,即 Topic 的创建、查看与删除等操作。
Group 管理
支持 Group 级别的资源管理,支持 SDK 创建 Group,并在控制台可视化展示消费组的状态、订阅的 Topic、消费位点等详细信息。
消息管理
功能
说明
重置消费位点
消息队列 Kafka版控制台支持重置消费位点,改变订阅者当前的消费位置,您可以通过重置消费位点功能直接从某个指定时间点、最新 offset 位点或指定 offset 位点来消费消息。
消息查询
支持按消息 ID 或时间范围筛选查询消息,可在线下载消息内容、查看消息详情。
监控告警
功能
说明
实时数据监控
通过火山引擎云监控服务实现实时的数据监控,全天候监控实例运行状态、资源水位与消息收发耗时等数据。
自定义告警配置
丰富的数据监控项目、自定义的告警策略,可实现多种场景、不同渠道的告警通知。
操作审计
功能
说明
操作审计
支持根据审计类型、Topic、源端 IP以及源端端口查询实例的生产和消费记录。
权限管理
功能
说明
Kafka 权限管理
支持 ACL 权限管理,完全兼容 Kafka 的所有的内置权限策略。
用户管理
支持控制台方式的用户管理,通过创建和管理 PLAIN 类型和 SCRAM 类型的用户实现更为安全的权限管理策略。
IAM 访问控制
完全对接火山引擎 IAM 服务,可为不同角色设置不同的实例访问策略,实现多场景的权限精细化管理。
集群迁移
功能
说明
在线迁移元数据
针对可访问公网的源 Kafka 集群提供的集群迁移方式。支持通过迁移工具,在线迁移源集群元数据至火山引擎消息队列 Kafka版实例。
离线迁移元数据
针对不可访问公网的源 Kafka 集群提供的集群迁移方式。支持通过迁移工具和控制台,离线迁移源集群元数据至火山引擎消息队列 Kafka版实例。
开发者工具
功能
说明
Open API
RPC 风格的 Open API 接口,全方位覆盖产品功能。
多语言 SDK
火山引擎消息队列 Kafka版兼容开源多语言的 SDK,对接便捷、安全可靠。
最近更新时间:2025.08.08 17:47:27
这个页面对您有帮助吗?
有用
有用
无用
无用