帮你快速理解、总结文档立即下载

使用 Schema Registry

最近更新时间:2026-11-18 17:37:32
我的收藏

操作场景

本文介绍如何在 CKafka 控制台开启 CKafka 自研的 Schema Registry 服务,获取接入信息,并为 Topic 创建、查看、更新和删除 Schema 版本。
说明:
Schema Registry 当前为白名单功能。如需使用,请 提交工单 申请开通白名单。
Schema Registry 当前处于公测阶段,暂不收费。

前提条件

账号已开启 Schema Registry 白名单。
已 创建 CKafka 实例,满足地域、形态等开启 Schema Registry 的限制条件,详情参见 Schema Registry 简介。
开启服务时,实例处于健康状态,且未执行其他变更操作。
管理 Topic Schema 前,已创建 Topic。

操作步骤

开启 Schema Registry

完成白名单开通后,按以下步骤在控制台开启服务。
1. 登录 CKafka 控制台。
2. 在左侧导航栏选择 实例列表,单击目标实例的 ID/名称,进入实例详情页。
3. 在实例详情页选择 Schema 管理。
4. 单击 开启,在确认对话框中再次单击开启。
5. 等待服务状态变为 已启用,即完成开启。
6. 开启成功后,在 Schema 管理页面的 接入方式 区域查看接入信息。
信息
说明
接入地址
Schema Registry 的 VPC 接入地址,用于客户端连接 Schema Registry。
网络
接入地址所属的 VPC 和子网。
用户
Schema Registry 访问用户名。
密码
Schema Registry 访问密码。
说明:
在开启过程中,实例状态会显示为“升级中”。请等待开启完成后,再执行其他实例变更操作。如果开启失败,请检查实例状态和页面提示;仍无法解决时,可 提交工单。

创建 Schema

1. 在实例详情页进入 Topic 列表。
2. 在目标 Topic 的操作列中,选择 更多 > Schema 管理。
3. 在右侧窗口选择 Key 或 Value 页签。两者操作方式相同,分别管理对应消息部分的 Schema。
4. 单击创建 Schema,在窗口中配置以下参数。
参数
说明
格式
选择 JSON、AVRO 或 PROTOBUF。其中 JSON 指 JSON Schema 定义,不是业务消息样例。
兼容性配置
选择新版本需要遵循的兼容性策略,默认为 Backward。详细说明参见 Schema Registry 简介。
Schema 内容
输入与所选格式匹配的 Schema 定义,可在页面模板基础上修改。
5. 单击提交。系统检查 Schema 格式,创建 Schema 版本。

查看 Schema

1. 在实例详情页进入 Topic 列表。
2. 在目标 Topic 的操作列中,选择 更多 > Schema 管理。
3. 在右侧窗口选择 Key 或 Value 页签,可查看 Subject、兼容性配置、Schema ID、Schema 格式和内容。
4. 在版本下拉框中选择不同版本,可查看对应的历史 Schema。

更新 Schema

1. 在实例详情页进入 Topic 列表。
2. 在目标 Topic 的操作列中,选择 更多 > Schema 管理。
3. 在右侧窗口选择 Key 或 Value 页签,在版本区域单击编辑。
4. 修改 Schema 内容,单击 校验。检查格式及与当前兼容性策略是否一致。校验未通过时,按提示修改内容。
5. 单击 提交。系统再次校验,通过后完成注册,可选择最新版本号查看 Schema 内容。
说明:
Schema 更新以注册版本的方式完成,不会直接覆盖历史版本。
在同一 Subject 下重复提交已注册的相同 Schema,不会生成新版本。

修改兼容性配置

1. 在实例详情页进入 Topic 列表。
2. 在目标 Topic 的操作列中,选择 更多 > Schema 管理。
3. 在右侧窗口选择 Key 或 Value 页签,在兼容性配置区域单击编辑。
4. 选择目标策略,单击 确定。
注意:
新策略用于后续注册,不会重新校验或修改已有版本。修改前请确认相关生产者和消费者的兼容要求。

删除 Schema 版本

1. 在实例详情页进入 Topic 列表。
2. 在目标 Topic 的操作列中,选择 更多 > Schema 管理。
3. 在右侧窗口选择 Key 或 Value 页签,在版本下拉框中选择待删除版本,单击删除。
4. 确认目标版本及业务影响后,在确认对话框中单击 确定。