Get catalog details

Retrieving configuration properties exposes metadata for Lakehouse for Apache Iceberg.

Within the Lakehouse runtime catalog, inspecting an existing catalog (such as an Apache Iceberg REST catalog or Apache Hive catalog) reveals its details. For Apache Iceberg REST catalogs, this includes the REST catalog URI required for client connections, authentication method, and associated service account.

Before you begin

  1. Verify that billing is enabled for your Google Cloud project.

  2. Enable the BigLake API.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the API

Required roles

To get the permissions that you need to view catalog details, ask your administrator to grant you the following IAM roles on your project:

For more information about granting roles, see Manage access to projects, folders, and organizations.

You might also be able to get the required permissions through custom roles or other predefined roles.

Get catalog details

Inspect catalog configuration and properties.

Console

  1. In the Google Cloud console, open the Lakehouse page.

    Go to Lakehouse

  2. Click the name of any catalog.

  3. On the Catalog Details page, explore information about the catalog such as catalog ID, creation timestamp, REST catalog URI, authentication method, and service account.

REST

To retrieve catalog details and configuration using the REST API, make a GET request to the GetIcebergCatalog endpoint:

GET /iceberg/v1/restcatalog/extensions/projects/PROJECT_ID/catalogs/CATALOG_ID

The response contains an IcebergCatalog JSON object describing the catalog configuration.

Replace the following:

  • PROJECT_ID: your Google Cloud project ID.
  • CATALOG_ID: the ID of your Lakehouse runtime catalog.