The Lakehouse runtime catalog lets you inspect the configuration and
metadata of
[catalog endpoints](https://docs.cloud.google.com/lakehouse/docs/about-lakehouse-catalogs.md.txt#configuration) in
borderless Lakehouse.

For Apache Iceberg REST catalog endpoints, you can retrieve the REST catalog
URI required for client connections, the authentication method, and the
associated service account.

## Before you begin

1. Read [About the Lakehouse runtime catalog](https://docs.cloud.google.com/lakehouse/docs/about-lakehouse-catalogs.md.txt) to understand how the Lakehouse runtime catalog works and the limitations for the service.

### Required roles


To get the permissions that
you need to view catalog endpoint details,

ask your administrator to grant you the
following IAM roles on your project:

- All:
  - [BigLake Admin](https://docs.cloud.google.com/iam/docs/roles-permissions/biglake.md.txt#biglake.admin) (`roles/biglake.admin`)
  - [Storage Admin](https://docs.cloud.google.com/iam/docs/roles-permissions/storage.md.txt#storage.admin) (`roles/storage.admin`)


For more information about granting roles, see [Manage access to projects, folders, and organizations](https://docs.cloud.google.com/iam/docs/granting-changing-revoking-access.md.txt).


You might also be able to get
the required permissions through [custom
roles](https://docs.cloud.google.com/iam/docs/creating-custom-roles) or other [predefined
roles](https://docs.cloud.google.com/iam/docs/roles-overview#predefined).

## Get catalog endpoint details

Inspect catalog endpoint configuration and properties.

### Console

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

   [Go to Lakehouse](https://console.cloud.google.com/biglake)
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.

   For federated catalogs, the **Catalog Details** page also displays the
   following properties when configured:
   - **Identity mode** : Displays `Service identity` or `User identity federation` for Databricks Unity Catalog connections.
   - **Service directory name**: Displays the Service Directory service resource name configured for private query transport on AWS Glue, Snowflake Horizon Catalog, and Databricks Unity Catalog connections.
   - **Metadata service directory name**: Displays the Service Directory service resource name configured for private background metadata refresh on AWS Glue, Snowflake Horizon Catalog, and Databricks Unity Catalog connections.

### gcloud

To describe a catalog endpoint by using the Google Cloud CLI, run the [`gcloud biglake iceberg catalogs describe` command](https://docs.cloud.google.com/sdk/gcloud/reference/biglake/iceberg/catalogs/describe).

```bash
gcloud biglake iceberg catalogs describe CATALOG_ID \
    --project="PROJECT_ID"
```

Replace the following:

- `CATALOG_ID`: the ID of your catalog.
- `PROJECT_ID`: your Google Cloud project ID.

### REST

To retrieve catalog endpoint details and configuration by using the REST API, make a `GET`
request to the [`GetIcebergCatalog`](https://docs.cloud.google.com/lakehouse/docs/reference/rest/v1/iceberg.v1.restcatalog.extensions.projects.catalogs/get.md.txt) 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 catalog.