O Google usa tecnologia de IA na tradução de conteúdos para seu idioma de preferência. As traduções com IA podem ter erros.

Ver um cluster do serviço gerenciado do Google Cloud para Apache Kafka

Para ver um cluster, use o console do Google Cloud , a Google Cloud CLI, a biblioteca de cliente ou a API Managed Kafka. Não é possível usar a API Apache Kafka de código aberto para visualizar um cluster.

Papéis e permissões necessários para visualizar um cluster

Para receber as permissões necessárias para visualizar um cluster, peça ao administrador para conceder a você o papel do IAM de Leitor do Kafka gerenciado (roles/managedkafka.viewer) no seu 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 visualizar um cluster. 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 visualizar um cluster:

Liste os clusters: managedkafka.clusters.list
Receba detalhes do cluster: managedkafka.clusters.get

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

Ver um cluster

Para ver um cluster, siga estas etapas:

Console

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

Acessar Clusters

Os clusters que você criou em um projeto são listados.
Para ver um cluster específico, clique no nome dele.
A página de detalhes do cluster é aberta. Esta página tem as seguintes guias:
- Recursos: exibe a lista de tópicos e grupos de consumidores associados ao cluster.
- Controle de acesso: exibe as entradas de ACL do cluster.
- Configurações: exibe a configuração do cluster, incluindo a lista de sub-redes associadas a ele.
- Monitoramento: exibe os alertas de monitoramento associados ao cluster.
- Registros: mostra os registros relacionados aos clusters da Análise de Registros.
- Origens: fornece atalhos para criar conectores de origem do Kafka Connect ou gerar dados de teste sintéticos.
- Sinks: fornece atalhos para criar conectores de coletor do Kafka Connect.

gcloud

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.

Antes de usar os dados do comando abaixo, faça estas substituições:

PROJECT_ID: o ID do projeto;
LOCATION: O local do cluster.
CLUSTER_ID: o ID do cluster.

Execute o seguinte comando:

Linux, macOS ou Cloud Shell

gcloud managed-kafka clusters describe CLUSTER_ID \
    --location=LOCATION \
    --project=PROJECT_ID

Windows (PowerShell)

gcloud managed-kafka clusters describe CLUSTER_ID `
    --location=LOCATION `
    --project=PROJECT_ID

Windows (cmd.exe)

gcloud managed-kafka clusters describe CLUSTER_ID ^
    --location=LOCATION ^
    --project=PROJECT_ID

Você receberá uma resposta semelhante a esta

bootstrapAddress: bootstrap.CLUSTER_ID.LOCATION.managedkafka.PROJECT_ID.cloud.goog:9092
bootstrapAddressMTLS: bootstrap.CLUSTER_ID.LOCATION.managedkafka.PROJECT_ID.cloud.goog:9192
brokerCapacityConfig: {}
capacityConfig:
  memoryBytes: 'MEMORY'
  vcpuCount: 'CPU_COUNT'
createTime: 'CREATE_TIME'
gcpConfig:
  accessConfig:
    networkConfigs:
    - subnet: projects/PROJECT_ID/regions/LOCATION/subnetworks/SUBNET_ID
    publicClusterConfig:
      allowedSourceIpRanges:
      - 203.0.113.5/32
labels:
  goog-terraform-provisioned: 'true'
name: projects/PROJECT_ID/locations/LOCATION/clusters/CLUSTER_ID
publicClusterDetails:
  discoveryDnsRecords:
  - discovery-1.CLUSTER_ID.LOCATION.managedkafka.PROJECT_ID.cloud.goog
  externalIpAddresses:
  - 203.0.113.1
  - 203.0.113.2
  - 203.0.113.3
  - 203.0.113.4
rebalanceConfig:
  mode: AUTO_REBALANCE_ON_SCALE_UP
satisfiesPzi: false
satisfiesPzs: false
state: ACTIVE
tlsConfig:
  trustConfig: {}
updateOptions: {}
updateTime: 'UPDATE_TIME'

REST

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

PROJECT_ID: o ID do projeto do Google Cloud .
LOCATION: O local do cluster.
CLUSTER_ID: o ID do cluster.
CLUSTER_VIEW: a quantidade de metadados a serem retornados. Especifique um dos seguintes valores:
- CLUSTER_VIEW_BASIC: retorna os metadados básicos do cluster.
- CLUSTER_VIEW_FULL: retorna todos os metadados do cluster, incluindo informações sobre os agentes do cluster e o número da versão do Kafka que o cluster está executando.
Se não for especificado, o método padrão será CLUSTER_VIEW_BASIC.

Método HTTP e URL:

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

Para enviar a solicitação, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

Observação: o comando a seguir pressupõe que você tenha feito login na CLI do gcloud com sua conta de usuário executando gcloud init ou gcloud auth login, ou usando o Cloud Shell, que faz login automaticamente na CLI gcloud. . Para saber qual é a conta ativa no momento, execute o comando gcloud auth list.

Execute o seguinte comando:

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)

Observação: o comando a seguir pressupõe que você tenha feito login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login . Para saber qual é a conta ativa no momento, execute o comando gcloud auth list.

Execute o seguinte comando:

$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

Você receberá uma resposta JSON semelhante a esta:

{
  "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"
        }
      ],
      "publicClusterConfig": {
        "allowedSourceIpRanges": [
          "203.0.113.5/32"
        ]
      }
    }
  },
  "state": "ACTIVE",
  "satisfiesPzi": false,
  "satisfiesPzs": false,
  "tlsConfig": {
    "trustConfig": {}
  },
  "updateOptions": {},
  "publicClusterDetails": {
    "discoveryDnsRecords": [
      "discovery-1.CLUSTER_ID.LOCATION.managedkafka.PROJECT_ID.cloud.goog"
    ],
    "externalIpAddresses": [
      "203.0.113.1",
      "203.0.113.2",
      "203.0.113.3",
      "203.0.113.4"
    ]
  }
}

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/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

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 se 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.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

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.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}")

Ver propriedades e recursos do cluster

As seções a seguir descrevem como ver detalhes sobre várias propriedades e recursos associados a um cluster do Serviço Gerenciado do Google Cloud para Apache Kafka.

Endereço de inicialização

Os clientes do Kafka usam o endereço de inicialização do cluster para estabelecer uma conexão com ele. O endereço de bootstrap é fixo durante o ciclo de vida de um cluster, mas o formato do URL de bootstrap pode variar entre os clusters.

Se o cluster tiver o acesso público ativado, o endereço de inicialização será resolvido automaticamente para endereços IP públicos ou privados, dependendo de onde o cliente estiver se conectando (usando DNS de horizonte dividido). Os clientes internos e externos precisam usar esse mesmo endereço de inicialização para se conectar ao cluster. Não configure os clientes do Kafka para se conectarem aos registros DNS de descoberta, que são reservados apenas para configurar firewalls de saída externos.

Para acessar o endereço de inicialização, siga estas etapas:

Console

Acesse a página Serviço Gerenciado para Apache Kafka > Clusters.

Acessar Clusters
Clique no nome do cluster.
Selecione a guia Configurações.
Se você estiver usando SASL para autenticação, o URL de bootstrap estará listado em URL de bootstrap.

Se você estiver usando o TLS mútuo (mTLS) para autenticação, o URL de bootstrap estará listado em URL de bootstrap do mTLS.

Clique em Copiar para copiar o valor.

gcloud

Para receber o URL de bootstrap, use o comando managed-kafka clusters describe.

Se você estiver usando SASL para autenticação, execute o seguinte comando:

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

Se você estiver usando o mutual TLS (mTLS) para autenticação, execute o seguinte comando:

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

Substitua:

CLUSTER_ID: o ID ou nome do cluster.
LOCATION: o local do cluster.

Se você tiver um endereço de inicialização e quiser encontrar o cluster correspondente, filtre a lista de clusters no console do Google Cloud ou execute gcloud managed-kafka clusters list com --filter="bootstrapAddress:BOOTSTRAP_ADDRESS". Para mais informações, consulte Listar seus clusters.

Para mais informações sobre a autenticação SASL e mTLS, consulte Tipos de autenticação para agentes do Kafka.

Agentes

Para ver os agentes no cluster, consulte Ver agentes em um cluster do Serviço Gerenciado para Apache Kafka.

Grupos de consumidores

Um grupo de consumidores é um conjunto de consumidores que cooperam para consumir dados de vários tópicos. Para ver os grupos de consumidores de um cluster, consulte as seguintes páginas:

Sub-redes

Para ver as sub-redes conectadas ao cluster, siga estas etapas:

Console

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

Acessar Clusters
Clique no nome do cluster.
Na página de detalhes do cluster, clique na guia Configurações. As sub-redes conectadas são listadas em Sub-redes.

gcloud

Execute o comando gcloud managed-kafka clusters describe:

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

Substitua:

CLUSTER_ID: o ID ou nome do cluster.
LOCATION: o local do cluster.

Para mais informações, consulte Configurar a rede para o Serviço Gerenciado para Apache Kafka.

Intervalos de IP de origem permitidos

Para ver os intervalos de IP de origem permitidos para um cluster público, siga estas etapas:

Console

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

Acessar Clusters
Clique no nome do cluster.
Clique na guia Configurações. Os intervalos de IP de origem permitidos estão listados na tabela Intervalos de IP de origem permitidos na coluna Intervalo de IP.

gcloud

Para ver os intervalos de IP de origem permitidos usando gcloud, verifique o campo gcpConfig.accessConfig.publicClusterConfig.allowedSourceIpRanges na resposta do comando gcloud managed-kafka clusters describe:
```
gcloud managed-kafka clusters describe CLUSTER_ID \
    --location=LOCATION \
    --format="yaml(gcpConfig.accessConfig.publicClusterConfig.allowedSourceIpRanges)"
```
Substitua:
- CLUSTER_ID: o ID ou nome do cluster.
- LOCATION: o local do cluster.

REST

Para conferir os intervalos de IP de origem permitidos usando a API REST, verifique o campo gcpConfig.accessConfig.publicClusterConfig.allowedSourceIpRanges na resposta de uma solicitação GET:

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

PROJECT_ID: o ID do projeto do Google Cloud .
LOCATION: O local do cluster.
CLUSTER_ID: o ID do cluster.
CLUSTER_VIEW: a quantidade de metadados a serem retornados. Especifique um dos seguintes valores:
- CLUSTER_VIEW_BASIC: retorna os metadados básicos do cluster.
- CLUSTER_VIEW_FULL: retorna todos os metadados do cluster, incluindo informações sobre os agentes do cluster e o número da versão do Kafka que o cluster está executando.
Se não for especificado, o método padrão será CLUSTER_VIEW_BASIC.

Método HTTP e URL:

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

Para enviar a solicitação, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

Execute o seguinte comando:

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)

Execute o seguinte comando:

$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

Você receberá uma resposta JSON semelhante a esta:

{
  "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"
        }
      ],
      "publicClusterConfig": {
        "allowedSourceIpRanges": [
          "203.0.113.5/32"
        ]
      }
    }
  },
  "state": "ACTIVE",
  "satisfiesPzi": false,
  "satisfiesPzs": false,
  "tlsConfig": {
    "trustConfig": {}
  },
  "updateOptions": {},
  "publicClusterDetails": {
    "discoveryDnsRecords": [
      "discovery-1.CLUSTER_ID.LOCATION.managedkafka.PROJECT_ID.cloud.goog"
    ],
    "externalIpAddresses": [
      "203.0.113.1",
      "203.0.113.2",
      "203.0.113.3",
      "203.0.113.4"
    ]
  }
}

Para mais informações sobre intervalos de IP de origem permitidos, consulte Clusters públicos.

Detalhes do cluster público

Para conferir os detalhes do cluster público, incluindo os endereços IP externo e os registros DNS de descoberta, siga estas etapas:

Console

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

Acessar Clusters
Clique no nome do cluster.
Clique na guia Configurações. Os endereços IP externo e os registros DNS de descoberta são listados nos campos Endereços IP externos e Registros DNS de descoberta.

gcloud

Execute o comando gcloud managed-kafka clusters describe:

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

Substitua:

CLUSTER_ID: o ID ou nome do cluster.
LOCATION: o local do cluster.

REST

Para conferir os detalhes do cluster público usando a API REST, verifique o campo publicClusterDetails na resposta de uma solicitação GET:

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

PROJECT_ID: o ID do projeto do Google Cloud .
LOCATION: O local do cluster.
CLUSTER_ID: o ID do cluster.
CLUSTER_VIEW: a quantidade de metadados a serem retornados. Especifique um dos seguintes valores:
- CLUSTER_VIEW_BASIC: retorna os metadados básicos do cluster.
- CLUSTER_VIEW_FULL: retorna todos os metadados do cluster, incluindo informações sobre os agentes do cluster e o número da versão do Kafka que o cluster está executando.
Se não for especificado, o método padrão será CLUSTER_VIEW_BASIC.

Método HTTP e URL:

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

Para enviar a solicitação, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

Execute o seguinte comando:

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)

Execute o seguinte comando:

$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

Você receberá uma resposta JSON semelhante a esta:

{
  "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"
        }
      ],
      "publicClusterConfig": {
        "allowedSourceIpRanges": [
          "203.0.113.5/32"
        ]
      }
    }
  },
  "state": "ACTIVE",
  "satisfiesPzi": false,
  "satisfiesPzs": false,
  "tlsConfig": {
    "trustConfig": {}
  },
  "updateOptions": {},
  "publicClusterDetails": {
    "discoveryDnsRecords": [
      "discovery-1.CLUSTER_ID.LOCATION.managedkafka.PROJECT_ID.cloud.goog"
    ],
    "externalIpAddresses": [
      "203.0.113.1",
      "203.0.113.2",
      "203.0.113.3",
      "203.0.113.4"
    ]
  }
}

Tópicos

Para ver os tópicos em um cluster, consulte as seguintes páginas:

A seguir

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

Ver um cluster do serviço gerenciado do Google Cloud para Apache Kafka Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Papéis e permissões necessários para visualizar um cluster

Permissões necessárias

Ver um cluster

Console

gcloud

Linux, macOS ou Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

REST

curl (Linux, macOS ou Cloud Shell)

PowerShell (Windows)

Go

Java

Python

Ver propriedades e recursos do cluster

Endereço de inicialização

Console

gcloud

Agentes

Grupos de consumidores

Sub-redes

Console

gcloud

Intervalos de IP de origem permitidos

Console

gcloud

REST

curl (Linux, macOS ou Cloud Shell)

PowerShell (Windows)

Detalhes do cluster público

Console

gcloud

REST

curl (Linux, macOS ou Cloud Shell)

PowerShell (Windows)

Tópicos

A seguir

Ver um cluster do serviço gerenciado do Google Cloud para Apache Kafka