查看架构注册表详情

本文档将向您展示如何在 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

您也可以使用自定义角色或其他预定义角色来获取这些权限。

如需详细了解 Managed Service for Apache Kafka 可用的预定义角色，请参阅访问权限控制文档。

查看架构注册表详情

如需检索特定架构注册表的配置和详细信息，请按以下步骤操作：

控制台

  1. 在 Google Cloud 控制台中，前往架构注册表页面。

    前往架构注册表

    系统会显示项目中的架构注册表列表。

  2. 点击要查看其详细信息的架构注册表的名称。

    系统会打开架构注册表详情页面。有关此页面上显示的信息，请参阅 架构注册表页面详情部分。

gcloud

  1. 安装 Google Cloud CLI。 安装完成后，运行以下命令来初始化 Google Cloud CLI： 

    gcloud init

    如果您使用的是外部身份提供方 (IdP)，则必须先使用联合身份登录 gcloud CLI。

  2. 如需检索特定架构注册表的配置和详细信息，请运行 gcloud beta managed-kafka schema-registries describe 命令：

    3. gcloud beta managed-kafka schema-registries describe SCHEMA_REGISTRY_ID \
    --location=LOCATION \

    替换以下内容：

    • SCHEMA_REGISTRY_ID（必需）：您要描述的架构注册表的 ID。
    • LOCATION（必需）：架构注册表所在的 Google Cloud 区域。

例如，以下命令会获取位于 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 请求：
    • GET https://managedkafka.googleapis.com/v1main/projects/PROJECT_ID/locations/LOCATION/schemaRegistries/SCHEMA_REGISTRY_ID
Authorization: Bearer $(gcloud auth application-default print-access-token)

    替换以下内容：

    • PROJECT_ID（必需）：您的 Google Cloud 项目 ID。
    • LOCATION（必需）：架构注册表所在的区域。
    • SCHEMA_REGISTRY_ID（必需）：您要查看的架构注册表的唯一 ID。

如果请求成功，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。
  • 此架构注册表中的主题：与注册表关联的主题名称列表。如果有上下文，您还可以查看每个主题的上下文。
Apache Kafka® 是 Apache Software Foundation 或其关联公司在美国和/或其他国家/地区的注册商标。