Ce document vous explique comment afficher les détails d'une ressource de registre de schémas dans Managed Service pour Apache Kafka. Vous pouvez afficher des détails tels que sa configuration, les contextes et les sujets associés.
Vous ne pouvez pas utiliser les API client Apache Kafka Open Source pour afficher les détails spécifiques de ces ressources de registre de schémas Managed Service pour Apache Kafka.
Rôles et autorisations nécessaires
Pour obtenir les autorisations nécessaires pour afficher un registre de schémas, demandez à votre administrateur de vous accorder le rôle IAM Lecteur du registre de schémas Kafka géré (roles/managedkafka.schemaRegistryViewer) sur l'instance de registre de schémas.
Pour en savoir plus sur l'attribution de rôles, consultez Gérer l'accès aux projets, aux dossiers et aux organisations.
Ce rôle prédéfini contient les autorisations requises pour afficher un registre de schémas. Pour connaître les autorisations exactes requises, développez la section Autorisations requises :
Autorisations requises
Les autorisations suivantes sont requises pour afficher un registre de schémas :
-
Accordez cette autorisation sur la ressource du registre de schémas :
managedkafka.schemaRegistries.get
Vous pouvez également obtenir ces autorisations avec des rôles personnalisés ou d'autres rôles prédéfinis.
Pour en savoir plus sur les rôles prédéfinis disponibles pour Managed Service pour Apache Kafka, consultez la documentation sur le contrôle des accès.
Afficher les détails du registre de schémas
Pour récupérer la configuration et les détails d'un registre de schémas spécifique, procédez comme suit :
Console
- Dans la console Google Cloud , accédez à la page Registres de schémas.
Accéder aux registres de schémas
La liste des registres de schémas de votre projet s'affiche.
- Cliquez sur le nom du registre de schémas dont vous souhaitez afficher les détails.
La page Détails du registre de schémas s'ouvre. Les informations affichées sur cette page sont expliquées dans la section Détails de la page du registre de schémas.
gcloud
-
Installez la Google Cloud CLI. Une fois que la Google Cloud CLI est installée, initialisez-la en exécutant la commande suivante :
gcloud initSi vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.
- Pour récupérer la configuration et les détails d'un registre de schémas spécifique, exécutez la commande
gcloud beta managed-kafka schema-registries describe: - SCHEMA_REGISTRY_ID (obligatoire) : ID du registre de schémas que vous souhaitez décrire.
- LOCATION (obligatoire) : région Google Cloud dans laquelle se trouve le registre de schémas.
gcloud beta managed-kafka schema-registries describe SCHEMA_REGISTRY_ID \ --location=LOCATION \
Remplacez les éléments suivants :
Par exemple, la commande suivante permet d'obtenir les détails d'un registre de schémas appelé test_SR situé dans la région us-central1 :
gcloud beta managed-kafka schema-registries describe test_SR \ --location=us-central1
La commande renvoie un résultat semblable à celui-ci :
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
- Pour récupérer les détails d'une instance de registre de schémas spécifique à l'aide de l'API REST, envoyez une requête
GETà l'URI suivant : - PROJECT_ID (obligatoire) : ID de votre projet Google Cloud .
- LOCATION (obligatoire) : région dans laquelle se trouve le registre de schémas.
- SCHEMA_REGISTRY_ID (obligatoire) : ID unique du registre de schémas que vous souhaitez afficher.
GET https://managedkafka.googleapis.com/v1main/projects/PROJECT_ID/locations/LOCATION/schemaRegistries/SCHEMA_REGISTRY_ID Authorization: Bearer $(gcloud auth application-default print-access-token)
Remplacez les éléments suivants :
Si la requête aboutit, l'API renvoie un code d'état 200 OK. Le corps de la réponse contient un objet JSON représentant les détails du registre de schémas demandé.
Par exemple, voici une réponse à une commande permettant d'obtenir les détails d'un registre de schémas appelé gcloud_test situé dans la région 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/." ] }
Pour en savoir plus, consultez la documentation sur l'API REST.
Détails de la page du registre de schémas
Lorsque vous affichez un registre de schémas dans la console Google Cloud , la page Détails du registre de schémas affiche les informations suivantes pour le registre sélectionné :
- Région : région Google Cloud dans laquelle réside le registre.
- URL du registre de schémas : URL du point de terminaison du registre de schémas. au format
https://managedkafka.googleapis.com/v1main/projects/PROJECT_ID/locations/LOCATION/schemaRegistries/SCHEMA_REGISTRY_ID.Par exemple :
https://managedkafka.googleapis.com/v1main/projects/managed-kafka-project/locations/us-central1/schemaRegistries/testschemaregistry - Mode de schéma : mode opérationnel que vous pouvez définir au niveau du registre de schémas et au niveau de chaque sujet. Ce paramètre permet de contrôler si des modifications peuvent être apportées.
- Type de compatibilité : configuration au niveau du registre pour le paramètre de compatibilité par défaut appliqué aux nouveaux sujets ou versions de schéma dans ce registre (sauf s'il est remplacé au niveau du sujet ou du contexte).
Les valeurs courantes incluent
BACKWARD,FORWARD,FULLouNONE. - Sujets dans ce registre de schémas : liste des noms de sujets associés au registre. Si un contexte est disponible, vous pouvez également l'afficher pour chaque sujet.