本文档介绍了如何在 Managed Service for Apache Kafka 中查看架构注册表资源的详细信息。您可以查看配置、关联的上下文和主题等详细信息。
您无法使用开源 Apache Kafka 客户端 API 查看这些特定的 Managed Service for Apache Kafka 架构注册表资源详细信息。
所需角色和权限
如需获得查看架构注册表所需的权限,请让管理员向您授予架构注册表实例的Managed Kafka Schema Registry Viewer (roles/managedkafka.schemaRegistryViewer) IAM 角色。如需详细了解如何授予角色,请参阅管理对项目、文件夹和组织的访问权限。
此预定义角色包含 查看架构注册表所需的权限。如需查看所需的确切权限,请展开所需权限部分:
所需权限
如需查看架构注册表,您需要以下权限:
-
在架构注册表资源上授予此权限:
managedkafka.schemaRegistries.get
查看架构注册表详细信息
如需检索特定架构注册表的配置和详细信息,请按以下步骤操作:
控制台
- 在 Google Cloud 控制台中,前往 架构注册表 页面。
系统会显示项目中的架构注册表列表。
- 点击您要查看其详细信息的架构注册表的名称。
系统会打开架构注册表详细信息 页面。此页面上显示的信息在 架构注册表页面详细信息部分中进行了解释。
gcloud
-
安装 Google Cloud CLI。 安装完成后, 初始化 Google Cloud CLI,方法是运行以下命令:
gcloud init如果您使用的是外部身份提供方 (IdP),则必须先 使用联合身份登录 gcloud CLI。
- 如需检索特定架构注册表的配置和详细信息,请运行
gcloud beta managed-kafka schema-registries describe命令: - SCHEMA_REGISTRY_ID(必需):您要描述的架构注册表的 ID。
- LOCATION(必需):架构注册表所在的 Google Cloud 区域。
gcloud beta managed-kafka schema-registries describe SCHEMA_REGISTRY_ID \ --location=LOCATION \
替换以下内容:
例如,以下命令会获取位于 us-central1 区域中名为 test_SR 的架构注册表的详细信息:
gcloud beta managed-kafka schema-registries describe test_SR \ --location=us-central1
该命令会返回类似于以下内容的输出:
Describing schema registry: projects/test-pubsub/locations/us-central1/schemaRegistries/test_SR name: projects/test-pubsub/locations/us-central1/schemaRegistries/test_SR mode: READWRITE config: - compatibility: BACKWARD contexts: - projects/test-pubsub/locations/us-central1/schemaRegistries/test_SR/contexts/. - projects/test-pubsub/locations/us-central1/schemaRegistries/test_SR/contexts/user-record
REST
- 如需使用 REST API 检索特定架构注册表实例的详细信息,请向以下 URI 发出
GET请求: - PROJECT_ID(必需):您的 Google Cloud 项目 ID。
- LOCATION(必需):架构注册表所在的区域。
- SCHEMA_REGISTRY_ID(必需):您要查看的架构注册表的唯一 ID。
GET https://managedkafka.googleapis.com/v1main/projects/PROJECT_ID/locations/LOCATION/schemaRegistries/SCHEMA_REGISTRY_ID Authorization: Bearer $(gcloud auth application-default print-access-token)
替换以下内容:
如果请求成功,API 会返回 200 OK 状态代码。响应正文包含一个 JSON 对象,表示所请求的架构注册表的详细信息。
例如,以下是对用于获取位于 us-central1 区域中名为 gcloud_test 的架构注册表的详细信息的命令的响应:
{ "name": "projects/testing-311516/locations/us-central1/schemaRegistries/gcloud_test", "contexts": [ "projects/testing-311516/locations/us-central1/schemaRegistries/gcloud_test/contexts/default", "projects/testing-311516/locations/us-central1/schemaRegistries/gcloud_test/contexts/." ] }
如需了解详情,请参阅 REST API 文档。
架构注册表页面详细信息
在 Google Cloud 控制台中查看架构注册表时, **架构注册表详细信息** 页面会显示所选注册表的以下信息:
- 区域:注册表所在的 Google Cloud 区域。
- 架构注册表网址:架构
注册表的端点网址。此网址的格式为
https://managedkafka.googleapis.com/v1main/projects/PROJECT_ID/locations/LOCATION/schemaRegistries/SCHEMA_REGISTRY_ID.例如:
https://managedkafka.googleapis.com/v1main/projects/managed-kafka-project/locations/us-central1/schemaRegistries/testschemaregistry - 架构模式:您可以在 架构注册表级和各个主题级设置的操作模式。此设置控制是否可以进行修改。
- 兼容性类型:此注册表中为
新主题或架构版本强制执行的默认兼容性设置的
注册表级配置(除非在主题或上下文级被覆盖)。
常见值包括
BACKWARD、FORWARD、FULL或NONE。 - 此架构注册表中的主题:与注册表关联的主题 名称列表。如果有上下文,您还可以查看每个主题的上下文。