Cómo ver los detalles del registro de esquemas

En este documento, se muestra cómo ver los detalles de un recurso de registro de esquema en Managed Service for Apache Kafka. Puedes ver detalles como su configuración, los contextos asociados y los temas.

No puedes usar las APIs del cliente de Apache Kafka de código abierto para ver los detalles de estos recursos específicos del registro de esquemas de Managed Service para Apache Kafka.

Roles y permisos requeridos

Para obtener los permisos que necesitas para ver un registro de esquemas, pídele a tu administrador que te otorgue el rol de IAM de Visualizador del registro de esquemas de Kafka administrado (roles/managedkafka.schemaRegistryViewer) en la instancia del registro de esquemas. Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

Este rol predefinido contiene los permisos necesarios para ver un registro de esquemas. Para ver los permisos exactos que son necesarios, expande la sección Permisos requeridos:

Permisos necesarios

Se requieren los siguientes permisos para ver un registro de esquemas:

  • Otorga este permiso en el recurso del registro de esquemas: managedkafka.schemaRegistries.get

También puedes obtener estos permisos con roles personalizados o con otros roles predefinidos.

Para obtener más información sobre los roles predefinidos disponibles para Managed Service for Apache Kafka, consulta la documentación de control de acceso.

Cómo ver los detalles del registro de esquemas

Para recuperar la configuración y los detalles de un registro de esquema específico, sigue estos pasos:

Console

  1. En la consola Google Cloud , ve a la página Registros de esquemas.

    Ir a los registros de esquemas

    Se muestra una lista de los registros de esquemas de tu proyecto.

  2. Haz clic en el nombre del registro de esquemas cuyos detalles deseas ver.

    Se abrirá la página Detalles del registro de esquemas. La información que se muestra en esta página se explica en la sección Detalles de la página del registro de esquemas.

gcloud

  1. Instala Google Cloud CLI. Después de la instalación, inicializa Google Cloud CLI con el siguiente comando:

    gcloud init

    Si usas un proveedor de identidad externo (IdP), primero debes acceder a la gcloud CLI con tu identidad federada.

  2. Para recuperar la configuración y los detalles de un registro de esquema específico, ejecuta el comando gcloud beta managed-kafka schema-registries describe:
  3. gcloud beta managed-kafka schema-registries describe SCHEMA_REGISTRY_ID \
        --location=LOCATION \

    Reemplaza lo siguiente:

    • SCHEMA_REGISTRY_ID (obligatorio): Es el ID del registro de esquema que deseas describir.
    • LOCATION (obligatorio): La región Google Cloud en la que se encuentra el registro de esquemas.

Por ejemplo, el siguiente comando obtiene los detalles de un registro de esquema llamado test_SR ubicado en la región us-central1:

gcloud beta managed-kafka schema-registries describe test_SR \
    --location=us-central1

El comando devuelve un resultado similar al siguiente:

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 los detalles de una instancia específica del registro de esquemas con la API de REST, realiza una solicitud GET al siguiente URI:
  • GET https://managedkafka.googleapis.com/v1main/projects/PROJECT_ID/locations/LOCATION/schemaRegistries/SCHEMA_REGISTRY_ID
    Authorization: Bearer $(gcloud auth application-default print-access-token)
    

    Reemplaza lo siguiente:

    • PROJECT_ID (obligatorio): Es el ID de tu proyecto de Google Cloud .
    • LOCATION (obligatorio): Es la región en la que existe el registro de esquemas.
    • SCHEMA_REGISTRY_ID (obligatorio): Es el ID único del registro de esquemas que deseas ver.

Si la solicitud se realiza correctamente, la API devuelve un código de estado 200 OK. El cuerpo de la respuesta contiene un objeto JSON que representa los detalles del registro de esquema solicitado.

Por ejemplo, la siguiente es una respuesta a un comando para obtener los detalles de un registro de esquema llamado gcloud_test ubicado en la región 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 obtener más información, consulta la documentación de la API de REST.

Detalles de la página del registro de esquemas

Cuando ves un registro de esquema en la consola de Google Cloud , en la página Detalles del registro de esquema, se muestra la siguiente información del registro seleccionado:

  • Región: Es la región Google Cloud en la que reside el registro.
  • URL del registro de esquemas: Es la URL del extremo para el registro de esquemas. Tiene el formato https://managedkafka.googleapis.com/v1main/projects/PROJECT_ID/locations/LOCATION/schemaRegistries/SCHEMA_REGISTRY_ID.

    Por ejemplo: https://managedkafka.googleapis.com/v1main/projects/managed-kafka-project/locations/us-central1/schemaRegistries/testschemaregistry

  • Modo de esquema: Es el modo operativo que puedes configurar a nivel del registro de esquemas y del tema individual. Este parámetro de configuración controla si se pueden realizar modificaciones.
  • Tipo de compatibilidad: Es la configuración a nivel del registro para el parámetro de configuración de compatibilidad predeterminado que se aplica a los temas o las versiones de esquemas nuevos dentro de este registro (a menos que se anule a nivel del tema o del contexto). Los valores comunes incluyen BACKWARD, FORWARD, FULL o NONE.
  • Sujetos en este registro de esquemas: Es una lista de nombres de sujetos asociados con el registro. Si hay un contexto disponible, también puedes verlo para cada tema.
Apache Kafka® es una marca registrada de The Apache Software Foundation o sus afiliados en Estados Unidos y otros países.