查看結構定義登錄詳細資料

本文說明如何查看 Managed Service for Apache Kafka 中的結構定義登錄資源詳細資料。您可以查看詳細資料，例如設定、相關聯的內容和主題。

您無法使用開放原始碼 Apache Kafka 用戶端 API，查看這些特定的 Managed Service for Apache Kafka Schema Registry 資源詳細資料。

必要角色和權限

如要取得查看結構定義儲存庫所需的權限，請要求管理員授予您結構定義儲存庫執行個體的「Managed Kafka Schema Registry Viewer」 (roles/managedkafka.schemaRegistryViewer) IAM 角色。如要進一步瞭解如何授予角色，請參閱「管理專案、資料夾和組織的存取權」。

這個預先定義的角色具備查看結構定義登錄所需的權限。如要查看確切的必要權限，請展開「Required permissions」(必要權限) 部分：

所需權限

如要查看結構定義登錄，必須具備下列權限：

  • 在結構定義登錄資源上授予這項權限： managedkafka.schemaRegistries.get

您或許還可透過自訂角色或其他預先定義的角色取得這些權限。

如要進一步瞭解 Managed Service for Apache Kafka 適用的預先定義角色，請參閱存取權控管說明文件。

查看結構定義登錄詳細資料

如要擷取特定結構定義登錄的設定和詳細資料，請按照下列步驟操作：

控制台

  1. 前往 Google Cloud 控制台的「Schema registries」頁面。

    前往結構定義登錄

    畫面會顯示專案中的結構定義登錄清單。

  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® 是 The Apache Software Foundation 或其關聯企業在美國與/或其他國家/地區的註冊商標。