Visualizzare i dettagli del registro di schemi

Questo documento mostra come visualizzare i dettagli di una risorsa del registro di schema in Managed Service per Apache Kafka. Puoi visualizzare dettagli come la configurazione, i contesti associati e gli argomenti.

Non puoi utilizzare le API client Apache Kafka open source per visualizzare questi dettagli specifici delle risorse del registro di schema di Managed Service per Apache Kafka.

Ruoli e autorizzazioni richiesti

Per ottenere le autorizzazioni necessarie per visualizzare un registro degli schemi, chiedi all'amministratore di concederti il ruolo IAM Visualizzatore del registro degli schemi di Managed Kafka (roles/managedkafka.schemaRegistryViewer) nell'istanza del registro degli schemi. Per saperne di più sulla concessione dei ruoli, consulta Gestisci l'accesso a progetti, cartelle e organizzazioni.

Questo ruolo predefinito contiene le autorizzazioni necessarie per visualizzare un registro degli schemi. Per vedere quali sono esattamente le autorizzazioni richieste, espandi la sezione Autorizzazioni obbligatorie:

Autorizzazioni obbligatorie

Per visualizzare un registro degli schemi sono necessarie le seguenti autorizzazioni:

  • Concedi questa autorizzazione alla risorsa del registro degli schemi: managedkafka.schemaRegistries.get

Potresti anche ottenere queste autorizzazioni con ruoli personalizzati o altri ruoli predefiniti.

Per saperne di più sui ruoli predefiniti disponibili per Managed Service per Apache Kafka, consulta la documentazione sul controllo dell'accesso.

Visualizzare i dettagli del registro di schemi

Per recuperare la configurazione e i dettagli di un registro degli schemi specifico, segui questi passaggi:

Console

  1. Nella console Google Cloud , vai alla pagina Registri di schemi.

    Vai ai registri di schemi

    Viene visualizzato un elenco dei registri di schema nel tuo progetto.

  2. Fai clic sul nome del registro dello schema di cui vuoi visualizzare i dettagli.

    Viene visualizzata la pagina Dettagli registro schema. Le informazioni visualizzate in questa pagina sono spiegate nella sezione Dettagli della pagina del registro degli schemi.

gcloud

  1. Installa Google Cloud CLI. Dopo l'installazione, inizializza Google Cloud CLI eseguendo il comando seguente:

    gcloud init

    Se utilizzi un provider di identità (IdP) esterno, devi prima accedere a gcloud CLI con la tua identità federata.

  2. Per recuperare la configurazione e i dettagli di un registro dello schema specifico, esegui il comando gcloud beta managed-kafka schema-registries describe:
  3. gcloud beta managed-kafka schema-registries describe SCHEMA_REGISTRY_ID \
        --location=LOCATION \

    Sostituisci quanto segue:

    • SCHEMA_REGISTRY_ID (obbligatorio): l'ID del registro degli schemi che vuoi descrivere.
    • LOCATION (obbligatorio): la Google Cloud regione in cui si trova il registro degli schemi.

Ad esempio, il seguente comando recupera i dettagli di un registro di schemi chiamato test_SR che si trova nella regione us-central1:

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

Il comando restituisce un output simile al seguente:

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

  • Per recuperare i dettagli di un'istanza specifica del registro degli schemi utilizzando l'API REST, invia una richiesta GET al seguente 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)
    

    Sostituisci quanto segue:

    • PROJECT_ID (obbligatorio): il tuo Google Cloud ID progetto.
    • LOCATION (obbligatorio): la regione in cui esiste il registro di schemi.
    • SCHEMA_REGISTRY_ID (obbligatorio): l'ID univoco del registro degli schemi che vuoi visualizzare.

Se la richiesta ha esito positivo, l'API restituisce un codice di stato 200 OK. Il corpo della risposta contiene un oggetto JSON che rappresenta i dettagli del registro degli schemi richiesto.

Ad esempio, di seguito è riportata una risposta a un comando per ottenere i dettagli di un registro di schema denominato gcloud_test che si trova nella regione 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/."
  ]
}

Per saperne di più, consulta la documentazione dell'API REST.

Dettagli della pagina del registro di schema

Quando visualizzi un registro di schemi nella console Google Cloud , la pagina Dettagli registro di schemi mostra le seguenti informazioni per il registro selezionato:

  • Regione: la regione Google Cloud in cui si trova il registro.
  • URL del registro di schema: l'URL dell'endpoint per il registro di schema. Questo è nel formato https://managedkafka.googleapis.com/v1main/projects/PROJECT_ID/locations/LOCATION/schemaRegistries/SCHEMA_REGISTRY_ID.

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

  • Modalità dello schema: la modalità operativa che puoi impostare a livello di registro di schemi e di singolo soggetto. Questa impostazione controlla se è possibile apportare modifiche.
  • Tipo di compatibilità: la configurazione a livello di registro per l'impostazione di compatibilità predefinita applicata a nuovi soggetti o versioni dello schema all'interno di questo registro (a meno che non venga eseguito l'override a livello di soggetto o contesto). I valori comuni includono BACKWARD, FORWARD, FULL o NONE.
  • Soggetti in questo registro di schema: un elenco di nomi di soggetti associati al registro. Se è disponibile un contesto, puoi visualizzarlo anche per ogni materia.
Apache Kafka® è un marchio registrato di Apache Software Foundation o delle sue affiliate negli Stati Uniti e/o in altri paesi.