Lister les sujets

Vous pouvez lister les sujets d'un registre ou d'un contexte de schéma spécifique dans votre projet.

Ce document explique comment lister les sujets à l'aide de la consoleGoogle Cloud ou de l'API Managed Kafka.

Rôles et autorisations nécessaires

Pour obtenir les autorisations nécessaires pour lister les sujets, demandez à votre administrateur de vous accorder le rôle IAM Lecteur du registre de schémas Kafka géré (roles/managedkafka.schemaRegistryViewer) sur votre registre de schémas ou votre contexte. 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 lister les sujets. Pour connaître les autorisations exactes requises, développez la section Autorisations requises :

Autorisations requises

Les autorisations suivantes sont requises pour lister les sujets :

  • Accordez l'autorisation suivante sur le registre de schémas ou le contexte parent : managedkafka.googleapis.com/subjects.list

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, consultez la page Rôles prédéfinis de Managed Service pour Apache Kafka.

Lister les sujets d'un registre de schémas

Pour lister tous les sujets d'un registre de schémas ou d'un contexte spécifique de votre projet, procédez comme suit.

Console

  1. Dans la console Google Cloud , accédez à la page Registres de schémas.

    Accéder aux registres de schémas

  2. Cliquez sur le nom du registre de schémas dont vous souhaitez afficher les détails.

  3. Sur la page Détails du registre de schémas, les sujets sont listés sous Sujets dans ce registre de schémas.

  4. Facultatif : Pour filtrer les sujets affichés, cliquez sur Filtrer. Vous pouvez filtrer les données selon les propriétés suivantes :

    • Nom
    • Contexte
    • Supprimé de façon réversible (Oui/Non)

  5. Facultatif : Pour afficher ou masquer des colonnes, cliquez sur  Options d'affichage des colonnes, puis sélectionnez les colonnes que vous souhaitez afficher ou masquer.

REST

La demande doit être authentifiée à l'aide d'un jeton d'accès dans l'en-tête Authorization. Pour obtenir un jeton d'accès pour les identifiants par défaut actuels de l'application, exécutez la commande suivante : gcloud auth application-default print-access-token.

Pour lister les sujets directement sous un registre de schémas, envoyez une requête GET à l'URI spécifique à l'aide de la méthode projects.locations.schemaRegistries.schemas.subjects.list pour le contexte par défaut.

GET https://managedkafka.googleapis.com/v1main/projects/PROJECT_ID/locations/LOCATION/schemaRegistries/REGISTRY_ID/subjects
Authorization: Bearer $(gcloud auth application-default print-access-token)

Pour lister les sujets d'un contexte dans un registre de schémas, envoyez une requête GET à l'URI spécifique à l'aide de la méthode projects.locations.schemaRegistries.contexts.schemas.subjects.list :

GET https://managedkafka.googleapis.com/v1main/projects/PROJECT_ID/locations/LOCATION/schemaRegistries/REGISTRY_ID/contexts/CONTEXT_ID/subjects?subjectPrefix=SUBJECT_PREFIX
Authorization: Bearer $(gcloud auth application-default print-access-token)

Remplacez les éléments suivants :

  • PROJECT_ID (obligatoire) : ID de votre projet Google Cloud.

  • LOCATION (obligatoire) : Google Cloud région dans laquelle se trouve le registre de schémas.

  • REGISTRY_ID (obligatoire) : ID de votre registre de schémas.

  • CONTEXT_ID (facultatif) : ID du contexte (si la liste des sujets se trouve dans un contexte).

  • SUBJECT_PREFIX (facultatif) : contexte permettant de filtrer les sujets, au format :.{context}:. Si ce paramètre n'est pas défini, tous les sujets du registre sont renvoyés. Si la valeur est définie sur une chaîne vide, les sujets sont listés dans le contexte par défaut.

Si la requête aboutit, l'API renvoie un code d'état 200 OK. Le corps de la réponse contient un tableau JSON de noms de sujets.

Voici un exemple de réponse réussie des sujets dans un tableau JSON pour le contexte par défaut :

[
  "orders-topic-key",
  "orders-topic-value",
  "user-profile-event"
]

Les sujets dans des contextes non définis par défaut sont renvoyés au format :.context:subject.

Pour en savoir plus, consultez la documentation sur la méthode projects.locations.schemaRegistries.contexts.schemas.subjects/list.

Étapes suivantes

Apache Kafka® est une marque déposée d'Apache Software Foundation ou de ses filiales aux États-Unis et/ou dans d'autres pays.