列出所有結構定義儲存庫

您可以列出專案中的結構定義登錄。本文說明如何使用Google Cloud 控制台、Google Cloud CLI 或 Managed Kafka API 列出結構定義登錄。

必要角色和權限

如要取得列出結構定義登錄所需的權限,請要求管理員授予您專案和位置的「Managed Kafka 結構定義登錄檢視者」 (roles/managedkafka.schemaRegistryViewer) IAM 角色。如要進一步瞭解如何授予角色,請參閱「管理專案、資料夾和組織的存取權」。

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

所需權限

如要列出結構定義登錄檔,必須具備下列權限:

  • 在父項位置授予下列權限: managedkafka.schemaRegistries.list

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

您也可以透過「代管 Kafka 結構定義儲存庫編輯者」(roles/managedkafka.schemaRegistryEditor) 和「代管 Kafka 結構定義儲存庫管理員」 (roles/managedkafka.schemaRegistryAdmin) 等較高層級的角色,列出結構定義儲存庫。

如要進一步瞭解預先定義的角色,請參閱「Managed Service for Apache Kafka 預先定義的角色」。

列出結構定義儲存庫

如要列出專案中的所有結構定義登錄,請按照下列步驟操作。

控制台

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

    前往結構定義登錄

    這個頁面會顯示專案中的結構定義登錄清單。清單包含下列屬性的資料欄:

    • 名稱:結構定義登錄的專屬 ID。
    • 區域:架構登錄檔的託管 Google Cloud 區域。

gcloud

  1. 安裝 Google Cloud CLI。 完成後,執行下列指令來初始化 Google Cloud CLI:

    gcloud init

    若您採用的是外部識別資訊提供者 (IdP),請先使用聯合身分登入 gcloud CLI

  2. 執行 gcloud beta managed-kafka schema-registries list 指令:
  3. gcloud beta managed-kafka schema-registries list \
        --location=LOCATION \

    更改下列內容:

    • LOCATION (必要):要列出結構定義登錄的 Google Cloud 區域。

    舉例來說,如要列出 us-central1 位置的所有結構定義登錄,請執行下列指令:

    gcloud beta managed-kafka schema-registries list --location=us-central1

    輸出內容範例:

    NAME             LOCATION
    sr_docs      us-central1
    sr_docs23    us-central1
    sr23wert     us-central1

REST

如要列出結構定義登錄,請使用 projects.locations.schemaRegistries.list 方法。

使用任何要求資料之前,請先修改下列項目的值:

  • PROJECT_ID:您的 Google Cloud 專案 ID
  • LOCATION:要取得結構定義登錄清單的位置,例如 us-central1

HTTP 方法和網址:

GET https://managedkafka.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schemaRegistries?view=SCHEMA_REGISTRY_VIEW_FULL

請展開以下其中一個選項,以傳送要求:

您應該會收到如下的 JSON 回覆:

{
  "schemaRegistries": [
    {
      "name": "projects/PROJECT_ID/locations/LOCATION/REGISTRY_ID",
      "contexts": [
        "projects/PROJECT_ID/locations/LOCATION/REGISTRY_ID/contexts/.",
        "projects/PROJECT_ID/locations/LOCATION/REGISTRY_ID/contexts/CONTEXT_NAME"
      ]
    }
}

傳回的 JSON 物件包含指定位置中找到的結構定義登錄清單。如果 view 查詢參數為 SCHEMA_REGISTRY_VIEW_FULL,回應也會包含與每個結構定義登錄相關聯的內容。

Apache Kafka® 是 The Apache Software Foundation 或其關聯企業在美國與/或其他國家/地區的註冊商標。