Details der Schema-Registry ansehen

In diesem Dokument wird beschrieben, wie Sie die Details einer Schema-Registry-Ressource in Managed Service for Apache Kafka aufrufen. Sie können Details wie die Konfiguration, zugehörige Kontexte und Themen aufrufen.

Sie können die Open-Source-Client-APIs von Apache Kafka nicht verwenden, um diese spezifischen Ressourcendetails der Schema-Registry von Managed Service for Apache Kafka aufzurufen.

Erforderliche Rollen und Berechtigungen

Bitten Sie Ihren Administrator, Ihnen die IAM-Rolle Managed Kafka Schema Registry Viewer (roles/managedkafka.schemaRegistryViewer) für die Schemaregisterinstanz zuzuweisen, um die Berechtigungen zu erhalten, die Sie zum Aufrufen eines Schemaregisters benötigen. Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.

Diese vordefinierte Rolle enthält die Berechtigungen, die zum Aufrufen einer Schemaregistrierung erforderlich sind. Maximieren Sie den Abschnitt Erforderliche Berechtigungen, um die notwendigen Berechtigungen anzuzeigen:

Erforderliche Berechtigungen

Die folgenden Berechtigungen sind erforderlich, um eine Schemaregistrierung aufzurufen:

  • Gewähren Sie diese Berechtigung für die Schemaregisterressource: managedkafka.schemaRegistries.get

Sie können diese Berechtigungen auch mit benutzerdefinierten Rollen oder anderen vordefinierten Rollen erhalten.

Details der Schema-Registry ansehen

So rufen Sie die Konfiguration und Details einer bestimmten Schemaregistrierung ab:

Console

  1. Rufen Sie in der Google Cloud Console die Seite Schema-Registries auf.

    Zu Schema-Registries

    Eine Liste der Schemaregister in Ihrem Projekt wird angezeigt.

  2. Klicken Sie auf den Namen der Schemaregistrierung, deren Details Sie aufrufen möchten.

    Die Seite Schema Registry-Details wird geöffnet. Die auf dieser Seite angezeigten Informationen werden im Abschnitt Details zur Seite „Schema-Registry“ erläutert.

gcloud

  1. Installieren Sie die Google Cloud CLI. Initialisieren Sie die Google Cloud CLI nach der Installation mit dem folgenden Befehl:

    gcloud init

    Wenn Sie einen externen Identitätsanbieter (IdP) verwenden, müssen Sie sich zuerst mit Ihrer föderierten Identität in der gcloud CLI anmelden.

  2. Führen Sie den Befehl gcloud beta managed-kafka schema-registries describe aus, um die Konfiguration und Details einer bestimmten Schemaregistrierung abzurufen:
  3. gcloud beta managed-kafka schema-registries describe SCHEMA_REGISTRY_ID \
        --location=LOCATION \

    Ersetzen Sie Folgendes:

    • SCHEMA_REGISTRY_ID (erforderlich): Die ID der Schemaregistrierung, die Sie beschreiben möchten.
    • LOCATION (erforderlich): Die Google Cloud Region, in der sich die Schemaregistrierung befindet.

Mit dem folgenden Befehl werden beispielsweise die Details einer Schemaregistrierung namens test_SR in der Region us-central1 abgerufen:

gcloud beta managed-kafka schema-registries describe test_SR \
    --location=us-central1

Der Befehl gibt eine Ausgabe zurück, die in etwa so aussieht:

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

  • Wenn Sie die Details einer bestimmten Schemaregisterinstanz mit der REST API abrufen möchten, senden Sie eine GET-Anfrage an den folgenden URI:
  • GET https://managedkafka.googleapis.com/v1main/projects/PROJECT_ID/locations/LOCATION/schemaRegistries/SCHEMA_REGISTRY_ID
    Authorization: Bearer $(gcloud auth application-default print-access-token)
    

    Ersetzen Sie Folgendes:

    • PROJECT_ID (erforderlich): Ihre Google Cloud Projekt-ID.
    • LOCATION (erforderlich): die Region, in der sich die Schemaregistrierung befindet.
    • SCHEMA_REGISTRY_ID (erforderlich): die eindeutige ID der Schemaregistrierung, die Sie aufrufen möchten.

Wenn die Anfrage erfolgreich ist, gibt die API den Statuscode 200 OK zurück. Der Antworttext enthält ein JSON-Objekt, das die Details der angeforderten Schemaregistrierung darstellt.

Das Folgende ist beispielsweise eine Antwort auf einen Befehl zum Abrufen der Details einer Schemaregistrierung namens gcloud_test in der Region us-central1:

{
  "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/."
  ]
}

Weitere Informationen finden Sie in der REST API-Dokumentation.

Details zur Seite „Schema-Registry“

Wenn Sie eine Schemaregistrierung in der Google Cloud Console aufrufen, werden auf der Seite Details zur Schemaregistrierung die folgenden Informationen für die ausgewählte Registrierung angezeigt:

  • Region: Die Google Cloud Region, in der sich die Registry befindet.
  • Schema-Registry-URL: Die Endpunkt-URL für die Schema-Registry. Das Format ist https://managedkafka.googleapis.com/v1main/projects/PROJECT_ID/locations/LOCATION/schemaRegistries/SCHEMA_REGISTRY_ID.

    Beispiel: https://managedkafka.googleapis.com/v1main/projects/managed-kafka-project/locations/us-central1/schemaRegistries/testschemaregistry

  • Schemamodus: Der Betriebsmodus, den Sie auf der Ebene der Schema-Registry und der einzelnen Subjekte festlegen können. Mit dieser Einstellung wird festgelegt, ob Änderungen vorgenommen werden können.
  • Kompatibilitätstyp: Die Konfiguration auf Registry-Ebene für die Standardkompatibilitätseinstellung, die für neue Subjekte oder Schemaversionen in dieser Registry erzwungen wird (sofern nicht auf Subjekt- oder Kontextebene überschrieben). Gängige Werte sind BACKWARD, FORWARD, FULL oder NONE.
  • Subjekte in dieser Schema-Registry: Eine Liste der Subjektnamen, die mit der Registry verknüpft sind. Wenn ein Kontext verfügbar ist, können Sie ihn auch für jedes Thema aufrufen.
Apache Kafka® ist eine eingetragene Marke der Apache Software Foundation oder ihrer verbundenen Unternehmen in den USA und/oder anderen Ländern.