Listar seus clusters do Connect

O Serviço Gerenciado para Apache Kafka permite visualizar o status de funcionamento, a alocação de recursos e os detalhes de configuração de todos os clusters do Connect. Essa visualização consolidada ajuda você a gerenciar seus clusters do Connect em um só lugar.

Para listar os clusters do Connect, use o Google Cloud console, a CLI gcloud, a biblioteca de cliente ou a API Managed Kafka. Não é possível usar a API Apache Kafka de código aberto para listar clusters do Connect.

Papéis e permissões necessários para listar os clusters do Connect

Para receber as permissões necessárias para listar os clusters do Connect, peça ao administrador para conceder a você o papel do IAM de Leitor do Kafka gerenciado (roles/managedkafka.viewer) no projeto. Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

Esse papel predefinido contém as permissões necessárias para listar os clusters do Connect. Para acessar as permissões exatas necessárias, expanda a seção Permissões necessárias:

Permissões necessárias

As seguintes permissões são necessárias para listar os clusters do Connect:

  • Conceda a permissão de listar clusters no local especificado: managedkafka.connectClusters.list
  • Conceda a permissão para receber detalhes do cluster no local especificado: managedkafka.connectClusters.get

Essas permissões também podem ser concedidas com funções personalizadas ou outros papéis predefinidos.

Ver os clusters do Connect

Console

  1. No console do Google Cloud , acesse a página Clusters do Connect.

    Acessar clusters do Connect

  2. Os clusters que você criou em um projeto são listados. A página permite visualizar as seguintes propriedades do cluster:

    • Nome: o identificador exclusivo do cluster do Connect. É possível usá-lo para referenciar o cluster do Connect em várias operações.
    • Estado: indica o status de funcionamento atual do cluster do Connect, como Ativo.
    • Localização: a localização geográfica em que o cluster do Connect está hospedado.
    • Horário de atualização: o horário em que o cluster do Connect foi atualizado pela última vez.
    • vCPUs: o número de vCPUs atribuídas ao cluster do Connect.
    • Memória: a quantidade total de alocação de memória para o cluster do Connect.
    • Cluster principal do Kafka: o cluster do Serviço Gerenciado para Apache Kafka associado ao cluster do Connect.
    • Rótulos: pares de chave-valor que podem ser anexados ao cluster do Connect para fins de organização, filtragem e automação.

gcloud

  1. No console do Google Cloud , ative o Cloud Shell.

    Ativar o Cloud Shell

    Na parte inferior do console do Google Cloud , uma sessão do Cloud Shell é iniciada e exibe um prompt de linha de comando. O Cloud Shell é um ambiente shell com a CLI do Google Cloud já instalada e com valores já definidos para o projeto atual. A inicialização da sessão pode levar alguns segundos.

  2. Use o comando gcloud managed-kafka connect-clusters list para listar os clusters do Connect:

    gcloud managed-kafka connect-clusters list \
        --location=LOCATION
    
  3. Para refinar ainda mais a lista de clusters do Connect, use outras flags:

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

    Substitua:

    • LOCATION: obrigatório. O local dos clusters do Connect que você quer listar.

    • EXPRESSION: (opcional) uma expressão de filtro booleano a ser aplicada à lista. Se a expressão for avaliada como True, o item será incluído na lista. Para mais detalhes e exemplos, execute gcloud topic filters.

    • LIMIT: (opcional) o número máximo de clusters do Connect a serem exibidos. Se não for especificado, todos os clusters do Connect serão listados.

    • PAGE_SIZE: (opcional) o número de resultados a serem exibidos por página. Se não for especificado, o serviço vai determinar um tamanho de página adequado.

    • SORT_BY: (opcional) uma lista separada por vírgulas de campos para usar na ordenação. A ordem de classificação padrão é crescente. Para classificar em ordem decrescente, adicione o prefixo ~ ao campo.

Exemplo de saída:

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

Go

Antes de testar esta amostra, siga as instruções de configuração do Go em Instalar as bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Go do Serviço Gerenciado para Apache Kafka.

Para autenticar no Serviço Gerenciado para Apache Kafka, configure o Application Default Credentials(ADC). Para mais informações, consulte Configurar o ADC para um ambiente de desenvolvimento 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

Antes de testar esta amostra, siga as instruções de configuração do Java em Instalar as bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Java do Serviço Gerenciado para Apache Kafka.

Para autenticar no Serviço Gerenciado para Apache Kafka, configure o Application Default Credentials. Para mais informações, consulte Configurar o ADC para um ambiente de desenvolvimento 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

Antes de testar este exemplo, siga as instruções de configuração do Python em Instalar as bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Python do Serviço Gerenciado para Apache Kafka.

Para autenticar no Serviço Gerenciado para Apache Kafka, configure o Application Default Credentials. Para mais informações, consulte Configurar o ADC para um ambiente de desenvolvimento 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}")

A seguir

Apache Kafka® é uma marca registrada da The Apache Software Foundation ou afiliadas nos Estados Unidos e/ou em outros países.