Google Cloud Managed Service for Apache Kafka-Cluster ansehen

Sie können einen Cluster über die Google Cloud -Konsole, die Google Cloud CLI, die Clientbibliothek oder die Managed Kafka API aufrufen. Sie können die Open-Source-Apache Kafka API nicht verwenden, um einen Cluster aufzurufen.

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:

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 ansehen

So rufen Sie einen Cluster auf:

Console

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

   Zu den Clustern

   Die Cluster, die Sie in einem Projekt erstellt haben, werden aufgelistet.

2. Wenn Sie einen bestimmten Cluster aufrufen möchten, klicken Sie auf den Clusternamen.

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 Subnetze, die dem Cluster zugeordnet sind.
   • Monitoring: Hier werden die Monitoring-Benachrichtigungen angezeigt, die mit dem Cluster verknüpft sind.
   • Logs: Hier werden die Logs für Cluster aus dem Log-Explorer angezeigt.

gcloud

1. In the Google Cloud console, activate Cloud Shell.

   Activate Cloud Shell

   At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

2. Zum Abrufen der aktuellen Richtlinie führen Sie den Befehl gcloud managed-kafka clusters describe 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 einfügen, gibt der Befehl zusätzliche Informationen zurück, einschließlich Informationen zu den Brokern des Clusters und der Kafka-Versionsnummer, die auf dem 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 zurückzugebenden Metadaten. 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, die auf dem Cluster ausgeführt wird.

  Wenn nichts angegeben ist, wird standardmäßig die Methode 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:

curl (Linux, macOS oder Cloud Shell)

Hinweis: Der folgende Befehl setzt voraus, dass Sie sich mit Ihrem Nutzerkonto in der gcloud-Befehlszeile angemeldet haben, indem Sie gcloud init oder gcloud auth login ausgeführt oder die Cloud Shell genutzt haben, die Sie automatisch in der gcloud-Befehlszeile anmeldet. Um herauszufinden, welches Konto gerade aktiv ist, führen Sie gcloud auth list aus.

Führen Sie folgenden Befehl aus:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://managedkafka.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/clusters/CLUSTER_ID?view=CLUSTER_VIEW"

PowerShell (Windows)

Hinweis: Der folgende Befehl setzt voraus, dass Sie sich mit Ihrem Nutzerkonto in der gcloud-Befehlszeile angemeldet haben, indem Sie gcloud init oder gcloud auth login ausgeführt haben. Um herauszufinden, welches Konto gerade aktiv ist, führen Sie gcloud auth list aus.

Führen Sie folgenden Befehl aus:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://managedkafka.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/clusters/CLUSTER_ID?view=CLUSTER_VIEW" | Select-Object -Expand Content

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

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

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

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

Richten Sie die Standardanmeldedaten für Anwendungen ein, um sich bei Managed Service for Apache Kafka zu authentifizieren. 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

Bevor Sie dieses Beispiel ausprobieren, folgen Sie der Anleitung für die Einrichtung von Python unter Clientbibliotheken installieren. Weitere Informationen finden Sie in der Referenzdokumentation zur Python API für Managed Service for Apache Kafka.

Richten Sie die Standardanmeldedaten für Anwendungen ein, um sich bei Managed Service for Apache Kafka zu authentifizieren. 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}")

Clusterattribute und ‑ressourcen ansehen

In den folgenden Abschnitten wird beschrieben, wie Sie Details zu verschiedenen Eigenschaften und Ressourcen abrufen, die einem Managed Service for Apache Kafka-Cluster zugeordnet 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 gegenseitige TLS-Authentifizierung (mTLS) verwenden, wird die Bootstrap-URL unter mTLS-Bootstrap-URL aufgeführt.

   Klicken Sie auf  Kopieren, um den Wert zu kopieren.

gcloud

Verwenden Sie den Befehl managed-kafka clusters describe, 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 gegenseitiges TLS (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

In Managed Service for Apache Kafka werden die Broker für einen Cluster automatisch bereitgestellt. Ein Broker hat die folgenden Eigenschaften:

• brokerIndex: Der nullbasierte Index des Brokers.
• nodeId: Die Knoten-ID für den Broker.
• rack: Die Zone, in der der Broker bereitgestellt wird, z. B. us-central1-a.

Führen Sie die folgenden Schritte aus, um die Broker für einen Cluster aufzurufen.

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. Die Broker des Clusters werden unter Active Brokers (Aktive Broker) aufgeführt.

gcloud

Verwenden Sie den Befehl managed-kafka clusters describe mit dem Flag --full, um eine Liste der Broker des Clusters abzurufen.

gcloud managed-kafka clusters describe CLUSTER_ID \
  --location=LOCATION \
  --full \
  --format="yaml(brokerDetails)"

Ersetzen Sie Folgendes:

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

Die Ausgabe sieht dann ungefähr so aus:

brokerDetails:
- brokerIndex: '0'
  nodeId: '10'
  rack: us-central1-c
- brokerIndex: '1'
  nodeId: '11'
  rack: us-central1-f
- brokerIndex: '2'
  nodeId: '12'
  rack: us-central1-b

Kafka-Befehlszeile

Bevor Sie diesen Befehl ausführen, installieren Sie die Kafka-Befehlszeilentools auf einer Compute Engine-VM. Die VM muss ein Subnetz erreichen können, das mit Ihrem Managed Service for Apache Kafka-Cluster verbunden ist. Folgen Sie der Anleitung unter Nachrichten mit den Kafka-Befehlszeilentools erstellen und verarbeiten.

Verwenden Sie den Befehl kafka-configs.sh --describe mit dem Flag --entity-type=brokers, um eine Liste der Broker des Clusters abzurufen.

kafka-configs.sh --describe --entity-type brokers \
  --bootstrap-server=BOOTSTRAP_ADDRESS \
  --command-config client.properties

Ersetzen Sie BOOTSTRAP_ADDRESS durch die Bootstrap-Adresse des Clusters.

Dieser Befehl gibt eine Liste von Broker-IDs zusammen mit ihren dynamischen Konfigurationseinstellungen zurück, sofern vorhanden. Die rack-Property wird nicht zurückgegeben.

Verbrauchergruppen

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

• Personengruppen auflisten
• Verbrauchergruppe ansehen

Subnetze

Führen Sie die folgenden Schritte aus, um die Subnetze aufzurufen, 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. Zum Abrufen der aktuellen Richtlinie führen Sie den Befehl gcloud managed-kafka clusters describe 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:

• Themen auflisten
• Thema ansehen

Nächste Schritte

• Cluster überwachen

• Erstellen Sie ein Thema in Ihrem Cluster.

• Cluster bearbeiten

• Cluster löschen

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