Este documento mostra como conferir os detalhes de um recurso de registro de esquema no Serviço gerenciado para Apache Kafka. É possível conferir detalhes como configuração, contextos e assuntos associados.
Não é possível usar as APIs de cliente do Apache Kafka de código aberto para ver esses detalhes específicos do recurso do registro de esquema do Serviço gerenciado para Apache Kafka.
Papéis e permissões necessárias
Para receber as permissões
necessárias para visualizar um registro de esquema,
peça ao administrador para conceder a você o
papel do IAM de Leitor do registro de esquema do Kafka gerenciado (roles/managedkafka.schemaRegistryViewer)
na instância do registro de esquema.
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 acessar um registro de esquema. 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 acessar um registro de esquema:
-
Conceda essa permissão no recurso do registro de esquema:
managedkafka.schemaRegistries.get
Essas permissões também podem ser concedidas com funções personalizadas ou outros papéis predefinidos.
Para mais informações sobre os papéis predefinidos disponíveis para o serviço gerenciado para Apache Kafka, consulte a documentação de controle de acesso.
Conferir detalhes do registro de esquema
Para recuperar a configuração e os detalhes de um registro de esquema específico, siga estas etapas:
Console
- No console do Google Cloud , acesse a página Registros de esquema.
Uma lista dos registros de esquema no seu projeto é exibida.
- Clique no nome do registro de esquema com os detalhes que você quer ver.
A página Detalhes do registro de esquema é aberta. As informações exibidas nesta página são explicadas na seção Detalhes da página do registro de esquema.
gcloud
-
Instale a CLI do Google Cloud. Após a instalação, inicialize a CLI do Google Cloud executando o seguinte comando:
gcloud initAo usar um provedor de identidade (IdP) externo, primeiro faça login na gcloud CLI com sua identidade federada.
- Para recuperar a configuração e os detalhes de um registro de esquema específico, execute o comando
gcloud beta managed-kafka schema-registries describe: - SCHEMA_REGISTRY_ID (obrigatório): o ID do registro de esquema que você quer descrever.
- LOCATION (obrigatório): a Google Cloud região em que o registro de esquema está localizado.
gcloud beta managed-kafka schema-registries describe SCHEMA_REGISTRY_ID \ --location=LOCATION \
Substitua:
Por exemplo, o comando a seguir extrai os detalhes de um registro de esquema chamado test_SR localizado na região us-central1:
gcloud beta managed-kafka schema-registries describe test_SR \ --location=us-central1
O comando retorna uma saída semelhante a esta:
Describing schema registry: projects/test-pubsub/locations/us-central1/schemaRegistries/test_SR name: projects/test-pubsub/locations/us-central1/schemaRegistries/test_SR mode: READWRITE config: - compatibility: BACKWARD contexts: - projects/test-pubsub/locations/us-central1/schemaRegistries/test_SR/contexts/. - projects/test-pubsub/locations/us-central1/schemaRegistries/test_SR/contexts/user-record
REST
- Para recuperar os detalhes de uma instância específica do registro de esquema usando a
API REST, faça uma solicitação
GETpara o seguinte URI: - PROJECT_ID (obrigatório): o ID do seu projeto do Google Cloud .
- LOCATION (obrigatório): a região em que o registro de esquema existe.
- SCHEMA_REGISTRY_ID (obrigatório): o ID exclusivo do registro de esquema que você quer visualizar.
GET https://managedkafka.googleapis.com/v1main/projects/PROJECT_ID/locations/LOCATION/schemaRegistries/SCHEMA_REGISTRY_ID Authorization: Bearer $(gcloud auth application-default print-access-token)
Substitua:
Se a solicitação for bem-sucedida, a API vai retornar um código de status 200 OK. O corpo da resposta contém um objeto JSON que representa os detalhes do
registro de esquema solicitado.
Por exemplo, a seguir está uma resposta a um comando para receber os detalhes de um registro de esquema chamado gcloud_test localizado na região us-central1:
{ "name": "projects/testing-311516/locations/us-central1/schemaRegistries/gcloud_test", "contexts": [ "projects/testing-311516/locations/us-central1/schemaRegistries/gcloud_test/contexts/default", "projects/testing-311516/locations/us-central1/schemaRegistries/gcloud_test/contexts/." ] }
Para mais informações, consulte a documentação da API REST.
Detalhes da página do registro de esquema
Ao visualizar um registro de esquema no console Google Cloud , a página Detalhes do registro de esquema mostra as seguintes informações sobre o registro selecionado:
- Região: a Google Cloud região em que o registro está localizado.
- URL do registro de esquema: o URL do endpoint para o registro de esquema. Ele precisa estar no formato
https://managedkafka.googleapis.com/v1main/projects/PROJECT_ID/locations/LOCATION/schemaRegistries/SCHEMA_REGISTRY_ID.Por exemplo:
https://managedkafka.googleapis.com/v1main/projects/managed-kafka-project/locations/us-central1/schemaRegistries/testschemaregistry - Modo de esquema: o modo operacional que pode ser definido no nível do registro de esquema e no nível do assunto individual. Essa configuração controla se as modificações podem ser feitas.
- Tipo de compatibilidade: a configuração no nível do registro para a configuração de compatibilidade padrão aplicada a novos assuntos ou versões de esquema nesse registro, a menos que seja substituída no nível do assunto ou do contexto.
Os valores comuns incluem
BACKWARD,FORWARD,FULLouNONE. - Assuntos neste registro de esquema: uma lista de nomes de assuntos associados ao registro. Se um contexto estiver disponível, você também poderá conferir o contexto de cada assunto.