Lister vos clusters Connect

Lorsque vous listez vos clusters Connect, vous pouvez afficher les détails de tous vos clusters Connect dans un seul volet, y compris des informations telles que l'état des clusters, leurs emplacements, leur temps d'activité, leur taille de calcul, le cluster Google Cloud Managed Service pour Apache Kafka associé et les étiquettes.

Pour lister vos clusters Connect, vous pouvez utiliser la Google Cloud console, la gcloud CLI, la bibliothèque cliente ou l' API Managed Kafka. Vous ne pouvez pas utiliser l'API Apache Kafka Open Source pour lister les clusters Connect.

Rôles et autorisations requis pour lister vos clusters Connect

Pour obtenir les autorisations nécessaires pour lister vos clusters Connect, demandez à votre administrateur de vous accorder le rôle IAM Lecteur Managed Kafka (roles/managedkafka.viewer) sur votre projet. 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 vos clusters Connect. Pour connaître les autorisations exactes requises, développez la section Autorisations requises :

Autorisations requises

Les autorisations suivantes sont requises pour lister vos clusters Connect :

  • Accordez l'autorisation de lister les clusters à l'emplacement spécifié : managedkafka.connectClusters.list
  • Accordez l'autorisation d'obtenir les détails du cluster à l'emplacement spécifié : managedkafka.connectClusters.get

Vous pouvez également obtenir ces autorisations avec des rôles personnalisés ou d'autres rôles prédéfinis.

Afficher vos clusters Connect

Console

  1. Dans la Google Cloud console, accédez à la page Connect Clusters.

    Accéder aux clusters Connect

  2. Les clusters que vous avez créés dans un projet sont listés. La page vous permet d'afficher les propriétés de cluster suivantes :

    • Name (Nom) : identifiant unique de votre cluster Connect. Vous pouvez l'utiliser pour faire référence au cluster Connect dans différentes opérations.
    • State (État) : indique l'état opérationnel actuel du cluster Connect, par exemple Active (Actif).
    • Location (Emplacement) : emplacement géographique où votre cluster Connect est hébergé.
    • Update time (Heure de mise à jour) : date et heure de la dernière mise à jour du cluster Connect.
    • vCPUs (Processeurs virtuels) : nombre de processeurs virtuels attribués au cluster Connect.
    • Memory (Mémoire) : quantité totale de mémoire allouée au cluster Connect.
    • Primary Kafka cluster (Cluster Kafka principal) : cluster Managed Service pour Apache Kafka associé au cluster Connect.
    • Labels (Étiquettes) : paires clé/valeur que vous pouvez associer au cluster Connect à des fins d'organisation, de filtrage et d'automatisation.

gcloud

  1. Dans la Google Cloud console, activez Cloud Shell.

    Activer Cloud Shell

    En bas de la fenêtre de la console, une session Cloud Shell démarre et affiche une invite de ligne de commande. Google Cloud Cloud Shell est un environnement shell dans lequel Google Cloud CLI est déjà installé, et dans lequel des valeurs sont déjà définies pour votre projet actuel. L'initialisation de la session peut prendre quelques secondes.

  2. Utilisez la gcloud managed-kafka connect-clusters list commande pour lister les clusters Connect :

    gcloud managed-kafka connect-clusters list \
    --location=LOCATION

  3. Pour affiner la liste des clusters Connect, vous pouvez utiliser des indicateurs supplémentaires :

    gcloud managed-kafka connect-clusters list \
    --location=LOCATION \
    [--filter=EXPRESSION] \
    [--limit=LIMIT] \
    [--page-size=PAGE_SIZE] \
    [--sort-by=SORT_BY]

    Remplacez les éléments suivants :

    • LOCATION : valeur obligatoire. Emplacement des clusters Connect que vous souhaitez lister.

    • EXPRESSION : (facultatif) expression de filtre booléen à appliquer à la liste. Si l'expression renvoie la valeur True, l'élément est inclus dans la liste. Pour plus de détails et d'exemples, exécutez gcloud topic filters.

    • LIMIT : (facultatif) nombre maximal de clusters Connect à afficher. Si ce paramètre n'est pas spécifié, tous les clusters Connect sont listés.

    • PAGE_SIZE : (facultatif) nombre de résultats à afficher par page. Si ce paramètre n'est pas spécifié, le service détermine une taille de page appropriée.

    • SORT_BY : (facultatif) liste de champs séparés par une virgule à trier. L'ordre de tri par défaut est croissant. Pour trier par ordre décroissant, ajoutez le préfixe ~ au champ.

Exemple de résultat :

NAME                   VCPU  MEMORY_BYTES  STATE   NETWORK
connect-cluster-alpha  3     3221225472    ACTIVE
connect-cluster-beta   3     3221225472    ACTIVE

Go

Avant d'essayer cet exemple, suivez les instructions de configuration pour Go dans Installer les bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Managed Service pour Apache Kafka en langage Go.

Pour vous authentifier auprès de Managed Service pour Apache Kafka, configurez les identifiants par défaut de l'application(ADC). Pour en savoir plus, consultez Configurer les ADC pour un environnement de développement local.

import (
	"context"
	"fmt"
	"io"

	"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
	"google.golang.org/api/iterator"
	"google.golang.org/api/option"

	managedkafka "cloud.google.com/go/managedkafka/apiv1"
)

func listConnectClusters(w io.Writer, projectID, region string, opts ...option.ClientOption) error {
	// projectID := "my-project-id"
	// region := "us-central1"
	ctx := context.Background()
	client, err := managedkafka.NewManagedKafkaConnectClient(ctx, opts...)
	if err != nil {
		return fmt.Errorf("managedkafka.NewManagedKafkaConnectClient got err: %w", err)
	}
	defer client.Close()

	locationPath := fmt.Sprintf("projects/%s/locations/%s", projectID, region)
	req := &managedkafkapb.ListConnectClustersRequest{
		Parent: locationPath,
	}
	clusterIter := client.ListConnectClusters(ctx, req)
	for {
		res, err := clusterIter.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			return fmt.Errorf("clusterIter.Next() got err: %w", err)
		}
		fmt.Fprintf(w, "Got connect cluster: %v", res)
	}
	return nil
}

Java

Avant d'essayer cet exemple, suivez les instructions de configuration pour Java dans Installer les bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Managed Service pour Apache Kafka en langage Java.

Pour vous authentifier auprès de Managed Service pour Apache Kafka, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer les ADC pour un environnement de développement local.

import com.google.api.gax.rpc.ApiException;
import com.google.cloud.managedkafka.v1.ConnectCluster;
import com.google.cloud.managedkafka.v1.LocationName;
import com.google.cloud.managedkafka.v1.ManagedKafkaConnectClient;
import java.io.IOException;

public class ListConnectClusters {

  public static void main(String[] args) throws Exception {
    // TODO(developer): Replace these variables before running the example.
    String projectId = "my-project-id";
    String region = "my-region"; // e.g. us-east1
    listConnectClusters(projectId, region);
  }

  public static void listConnectClusters(String projectId, String region) throws Exception {
    try (ManagedKafkaConnectClient managedKafkaConnectClient = 
        ManagedKafkaConnectClient.create()) {
      LocationName locationName = LocationName.of(projectId, region);
      // This operation is being handled synchronously.
      for (ConnectCluster connectCluster : managedKafkaConnectClient
          .listConnectClusters(locationName).iterateAll()) {
        System.out.println(connectCluster.getAllFields());
      }
    } catch (IOException | ApiException e) {
      System.err.printf("managedKafkaConnectClient.listConnectClusters got err: %s\n", 
          e.getMessage());
    }
  }
}

Python

Avant d'essayer cet exemple, suivez les instructions de configuration pour Python dans Installer les bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Python de Managed Service pour Apache Kafka.

Pour vous authentifier auprès de Managed Service pour Apache Kafka, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer les ADC pour un environnement de développement local.

from google.cloud import managedkafka_v1
from google.cloud.managedkafka_v1.services.managed_kafka_connect import (
    ManagedKafkaConnectClient,
)
from google.api_core.exceptions import GoogleAPICallError

# TODO(developer)
# project_id = "my-project-id"
# region = "us-central1"

connect_client = ManagedKafkaConnectClient()

request = managedkafka_v1.ListConnectClustersRequest(
    parent=connect_client.common_location_path(project_id, region),
)

response = connect_client.list_connect_clusters(request=request)
for cluster in response:
    try:
        print("Got Connect cluster:", cluster)
    except GoogleAPICallError as e:
        print(f"Failed to list Connect clusters with error: {e}")

Étape suivante

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.