文档中心
文档
备案
控制台
登录
立即注册
导航
消息队列 Kafka版
搜索目录或文档标题
搜索目录或文档标题
产品动态
新功能发布记录
产品公告
消息队列 Kafka版正式商用通知
计算规格名称调整说明
产品介绍
什么是消息队列 Kafka版
产品优势
产品功能
产品规格
相关概念
地域及可用区
限制说明
产品计费
计费概述
计费项
计费类型
按量计费
包年包月
转包年包月
实例续费
欠费或到期说明
退订或变配费用说明
税费及发票
快速入门
概述
准备环境
创建资源
连接实例
使用 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 管理权限
可授权的资源和操作
跨服务访问
访问策略模板
白名单管理
创建白名单
为白名单绑定实例
为白名单解绑实例
查看白名单信息
修改白名单
删除白名单
Connector
创建 TOS Sink Connector 任务
集群迁移
集群迁移概述
创建迁移任务
迁移元数据
在线迁移元数据
离线迁移元数据
导入元数据
修改迁移数据配置
查看迁移命令
删除迁移任务
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策略
标签管理
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
概述
准备工作
默认接入点收发消息
SASL_PLAINTEXT 接入点 PLAIN 机制收发消息
SASL_PLAINTEXT 接入点 SCRAM 机制收发消息
SASL_SSL 接入点 PLAIN 机制收发消息
SASL_SSL 接入点 SCRAM 机制收发消息
配置文件
Go 客户端 SDK
概述
准备工作
默认接入点收发消息
SASL_PLAINTEXT 接入点 PLAIN 机制收发消息
SASL_PLAINTEXT 接入点 SCRAM 机制收发消息
SASL_SSL 接入点 PLAIN 机制收发消息
SASL_SSL 接入点 SCRAM 机制收发消息
SDK 配置说明
Python 客户端 SDK
概述
准备工作
默认接入点收发消息
SASL_PLAINTEXT 接入点 PLAIN 机制收发消息
SASL_PLAINTEXT 接入点 SCRAM 机制收发消息
SASL_SSL 接入点 PLAIN 机制收发
SASL_SSL 接入点 SCRAM 机制收发消息
SDK 配置说明
C++ 客户端 SDK
概述
准备工作
默认接入点收发消息
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 接入点进行压力测试
数据压缩算法推荐
常见问题
产品咨询
实例管理
Topic 和 Group 管理
实例连接
消息生产与消费
问题排查
实例管理
Topic 和 Group 管理
监控
客户端
消息查询
相关协议
产品和服务测试协议
中间件产品服务条款
消息队列服务等级协议（SLA）
文档首页
/
消息队列 Kafka版
/
最佳实践
/
Topic 使用建议
Topic 使用建议
最近更新时间：2025.06.27 14:15:25
首次发布时间：2024.01.15 11:10:55
我的收藏
有用
有用
无用
无用
文档反馈