Google Cloud Managed Service for Apache Kafka-Cluster ansehen

Sie können einen Cluster über die Google Cloud Console, die Google Cloud CLI, die Clientbibliothek oder die Managed Kafka API aufrufen. Die Open-Source-Apache Kafka API kann nicht zum Aufrufen eines Clusters verwendet werden.

Erforderliche Rollen und Berechtigungen zum Aufrufen eines Clusters

Bitten Sie Ihren Administrator, Ihnen die IAM-Rolle Managed Kafka Viewer (roles/managedkafka.viewer) für Ihr Projekt zuzuweisen, um die Berechtigungen zu erhalten, die Sie zum Aufrufen eines Clusters 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 eines Clusters erforderlich sind. Maximieren Sie den Abschnitt Erforderliche Berechtigungen , um die notwendigen Berechtigungen anzuzeigen, die erforderlich sind:

Erforderliche Berechtigungen

Für das Aufrufen eines Clusters sind die folgenden Berechtigungen erforderlich:

  • Cluster auflisten: managedkafka.clusters.list
  • Clusterdetails abrufen: managedkafka.clusters.get

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

Weitere Informationen zur Rolle „Managed Kafka Viewer“ finden Sie unter Vordefinierte Rollen für Managed Service for Apache Kafka.

Cluster aufrufen

So rufen Sie einen Cluster auf:

Console

  1. Rufen Sie in der Google Cloud Console die Seite Cluster auf.

    Zu den Clustern

    Die in einem Projekt erstellten Cluster werden aufgelistet.

  2. Klicken Sie auf einen Clusternamen, um einen bestimmten Cluster aufzurufen.

  3. Die Seite mit den Clusterdetails wird geöffnet. Diese Seite enthält die folgenden Tabs:

    • Ressourcen: Hier wird die Liste der Themen und Verbrauchergruppen angezeigt, die mit dem Cluster verknüpft sind.
    • Konfigurationen: Hier wird die Konfiguration des Clusters angezeigt, einschließlich der Liste der mit dem Cluster verknüpften Subnetze.
    • Monitoring: Hier werden die mit dem Cluster verknüpften Monitoring-Benachrichtigungen angezeigt.
    • Logs: Hier werden die Logs zu Clustern aus dem Log-Explorer angezeigt.

gcloud

  1. Aktivieren Sie Cloud Shell in der Google Cloud Console.

    Cloud Shell aktivieren

    Unten in der Google Cloud Console wird eine Cloud Shell Sitzung gestartet und eine Befehlszeilenaufforderung angezeigt. Cloud Shell ist eine Shell-Umgebung in der das Google Cloud CLI bereits installiert ist und Werte für Ihr aktuelles Projekt bereits festgelegt sind. Das Initialisieren der Sitzung kann einige Sekunden dauern.

  2. Führen Sie den gcloud managed-kafka clusters describe Befehl aus:

    gcloud managed-kafka clusters describe CLUSTER_ID \
        --location=LOCATION \
        --full
    

    Ersetzen Sie Folgendes:

    • CLUSTER_ID: Die ID oder der Name des Clusters.
    • LOCATION: Der Standort des Clusters.

    Das Flag --full ist optional. Wenn Sie dieses Flag angeben, gibt der Befehl zusätzliche Informationen zurück, einschließlich Informationen zu den Brokern des Clusters und der Kafka-Versionsnummer, unter der der Cluster ausgeführt wird.

REST

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

  • PROJECT_ID: Ihre Google Cloud Projekt-ID
  • LOCATION: Der Standort des Clusters
  • CLUSTER_ID: Die ID des Clusters
  • CLUSTER_VIEW: Die Menge der Metadaten, die zurückgegeben werden sollen. Geben Sie einen der folgenden Werte an:

    • CLUSTER_VIEW_BASIC: Gibt die grundlegenden Metadaten für den Cluster zurück.
    • CLUSTER_VIEW_FULL: Gibt alle Metadaten für den Cluster zurück, einschließlich Informationen zu den Brokern des Clusters und der Kafka-Versionsnummer, unter der der Cluster ausgeführt wird.

    Wenn nicht angegeben, wird standardmäßig CLUSTER_VIEW_BASIC verwendet.

HTTP-Methode und URL:

GET https://managedkafka.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/clusters/CLUSTER_ID?view=CLUSTER_VIEW

Wenn Sie die Anfrage senden möchten, maximieren Sie eine der folgenden Optionen:

Sie sollten in etwa folgende JSON-Antwort erhalten:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/clusters/CLUSTER_ID",
  "createTime": "CREATE_TIME",
  "updateTime": "UPDATE_TIME",
  "capacityConfig": {
    "vcpuCount": "CPU_COUNT",
    "memoryBytes": "MEMORY"
  },
  "rebalanceConfig": {},
  "gcpConfig": {
    "accessConfig": {
      "networkConfigs": [
        {
          "subnet": "projects/PROJECT_ID/locations/LOCATION/subnetworks/SUBNET_ID"
        }
      ]
    }
  },
  "state": "ACTIVE",
  "satisfiesPzi": false,
  "satisfiesPzs": false,
  "tlsConfig": {
    "trustConfig": {}
  },
  "updateOptions": {}
}

Go

Folgen Sie der Einrichtungsanleitung für Go unter Clientbibliotheken installieren, bevor Sie dieses Beispiel anwenden. Weitere Informationen finden Sie in der Referenzdokumentation zur Managed Service for Apache Kafka Go API.

Richten Sie zur Authentifizierung bei Managed Service for Apache Kafka die Standardanmeldedaten für Anwendungen(Application Default Credentials, ADC) ein. Weitere Informationen finden Sie unter ADC für eine lokale Entwicklungsumgebung einrichten.

import (
	"context"
	"fmt"
	"io"

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

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

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

	clusterPath := fmt.Sprintf("projects/%s/locations/%s/clusters/%s", projectID, region, clusterID)
	req := &managedkafkapb.GetClusterRequest{
		Name: clusterPath,
	}
	cluster, err := client.GetCluster(ctx, req)
	if err != nil {
		return fmt.Errorf("client.GetCluster got err: %w", err)
	}
	fmt.Fprintf(w, "Got cluster: %#v\n", cluster)
	return nil
}

Java

Folgen Sie der Einrichtungsanleitung für Java unter Clientbibliotheken installieren, bevor Sie dieses Beispiel anwenden. Weitere Informationen finden Sie in der Referenzdokumentation zur Managed Service for Apache Kafka Java API.

Richten Sie zur Authentifizierung bei Managed Service for Apache Kafka die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter ADC für eine lokale Entwicklungsumgebung einrichten.

import com.google.api.gax.rpc.ApiException;
import com.google.cloud.managedkafka.v1.Cluster;
import com.google.cloud.managedkafka.v1.ClusterName;
import com.google.cloud.managedkafka.v1.ManagedKafkaClient;
import java.io.IOException;

public class GetCluster {

  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
    String clusterId = "my-cluster";
    getCluster(projectId, region, clusterId);
  }

  public static void getCluster(String projectId, String region, String clusterId)
      throws Exception {
    try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
      // This operation is being handled synchronously.
      Cluster cluster = managedKafkaClient.getCluster(ClusterName.of(projectId, region, clusterId));
      System.out.println(cluster.getAllFields());
    } catch (IOException | ApiException e) {
      System.err.printf("managedKafkaClient.getCluster got err: %s", e.getMessage());
    }
  }
}

Python

Folgen Sie der Einrichtungsanleitung für Python unter Clientbibliotheken installieren, bevor Sie dieses Beispiel anwenden. Weitere Informationen finden Sie in der Referenzdokumentation zur Managed Service for Apache Kafka Python API.

Richten Sie zur Authentifizierung bei Managed Service for Apache Kafka die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter ADC für eine lokale Entwicklungsumgebung einrichten.

from google.api_core.exceptions import NotFound
from google.cloud import managedkafka_v1

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

client = managedkafka_v1.ManagedKafkaClient()

cluster_path = client.cluster_path(project_id, region, cluster_id)
request = managedkafka_v1.GetClusterRequest(
    name=cluster_path,
)

try:
    cluster = client.get_cluster(request=request)
    print("Got cluster:", cluster)
except NotFound as e:
    print(f"Failed to get cluster {cluster_id} with error: {e.message}")

Cluster-Eigenschaften und -Ressourcen aufrufen

In den folgenden Abschnitten wird beschrieben, wie Sie Details zu verschiedenen Eigenschaften und Ressourcen abrufen, die mit einem Managed Service for Apache Kafka-Cluster verknüpft sind.

Bootstrap-Adresse

Kafka-Clients verwenden die Bootstrap-Adresse des Clusters, um eine Verbindung zum Cluster herzustellen. So rufen Sie die Bootstrap-Adresse ab:

Console

  1. Rufen Sie die Seite Managed Service for Apache Kafka > Cluster auf.

    Zu den Clustern

  2. Klicken Sie auf den Namen des Clusters.

  3. Wählen Sie den Tab Konfigurationen aus.

  4. Wenn Sie SASL zur Authentifizierung verwenden, wird die Bootstrap-URL unter mTLS-Bootstrap-URL aufgeführt.

    Wenn Sie die gegenseitige TLS-Authentifizierung (mTLS) zur Authentifizierung verwenden, wird die Bootstrap-URL unter mTLS-Bootstrap-URL aufgeführt.

    Klicken Sie auf Kopieren , um den Wert zu kopieren.

gcloud

Verwenden Sie den managed-kafka clusters describe Befehl, um die Bootstrap-URL abzurufen.

Wenn Sie SASL zur Authentifizierung verwenden, führen Sie den folgenden Befehl aus:

gcloud managed-kafka clusters describe CLUSTER_ID \
  --location=LOCATION \
  --format="value(bootstrapAddress)"

Wenn Sie die gegenseitige TLS-Authentifizierung (mTLS) zur Authentifizierung verwenden, führen Sie den folgenden Befehl aus:

gcloud managed-kafka clusters describe CLUSTER_ID \
  --location=LOCATION \
  --format="value(bootstrapAddressMTLS)"

Ersetzen Sie Folgendes:

  • CLUSTER_ID: Die ID oder der Name des Clusters.
  • LOCATION: Der Standort des Clusters.

Weitere Informationen zur SASL- und mTLS-Authentifizierung finden Sie unter Authentifizierungstypen für Kafka-Broker.

Makler

Informationen zum Aufrufen der Broker in Ihrem Cluster finden Sie unter Broker in einem Managed Service for Apache Kafka-Cluster aufrufen.

Verbrauchergruppen

Eine Verbrauchergruppe ist eine Gruppe von Verbrauchern, die zusammenarbeiten, um Daten aus verschiedenen Themen zu nutzen. Informationen zum Aufrufen der Verbrauchergruppen für einen Cluster finden Sie auf den folgenden Seiten:

Subnetze

So rufen Sie die Subnetze auf, die mit Ihrem Cluster verbunden sind:

Console

  1. Rufen Sie in der Google Cloud Console die Seite Cluster auf.

    Zu den Clustern

  2. Klicken Sie auf den Namen des Clusters.

  3. Klicken Sie auf der Seite mit den Clusterdetails auf den Tab Konfigurationen. Verbundene Subnetze werden unter Subnetze aufgeführt.

gcloud

  1. Führen Sie den gcloud managed-kafka clusters describe Befehl aus:

    gcloud managed-kafka clusters describe CLUSTER_ID \
        --location=LOCATION \
        --format="yaml(gcpConfig.accessConfig.networkConfigs)"
    

    Ersetzen Sie Folgendes:

    • CLUSTER_ID: Die ID oder der Name des Clusters.
    • LOCATION: Der Standort des Clusters.

Weitere Informationen finden Sie unter Netzwerk für Managed Service for Apache Kafka konfigurieren.

Themen

Informationen zum Aufrufen der Themen in einem Cluster finden Sie auf den folgenden Seiten:

Nächste Schritte

Apache Kafka® ist eine eingetragene Marke der Apache Software Foundation oder ihrer Tochtergesellschaften in den USA und/oder anderen Ländern.