Skip to content

Lakehouses

All operations require authentication.

2 operationsv2/publicCloud/project
View as Markdown (opens in a new tab)
Agent setup

Get the query activity of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/usage

Returns the queries your lakehouse ran over the last seven UTC days, today included, and the seven days before: counts, failures, data scanned, CPU time and latency, in total, per day, per catalog and per engine. The figures are read live from the region at each call and are indicative: they are not what you are billed. They carry no statement, user or table name. The data console of the lakehouse shows those.

Latency figures are upper bounds of buckets of elapsed time, which includes queueing. Counters the region started to record on countersSince are null for a period that starts before it. A lakehouse with no query activity yet answers zeros, over seven days and five bands. Only while the region does not hold the lakehouse yet, or does not serve its activity yet, are daily and latencyBands empty.

Path parameters

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

Response

200Usagesuccessful operation
activity
read-only
UsageActivity

Counters of every engine of the lakehouse

catalogs
read-only
UsageCatalog[]

One entry per catalog read during the window, the most data scanned first, then one entry with a null catalogId summing the catalogs deleted since, when they were read

compute
read-only
UsageCompute[]

The shared SQL endpoint first, then one entry per DEDICATED Compute Pool that ran queries, then one entry with a null computePoolId summing the DEDICATED Compute Pools deleted since, when they ran queries

countersSince
read-only
stringdate-time

Start of the first UTC day from which failedQueries, elapsedTotalMilliseconds and the statements-only latency are counted. A period starting before it has them null and its latency covers every query.

dataSince
read-only
stringdate-time

Start of the first UTC day the region counted a query of the lakehouse. Null when it has counted none.

dedicatedComputeMeasured
read-only
boolean

Whether the region counts the queries of DEDICATED Compute Pools. While false, compute lists the shared SQL endpoint only.

generatedAt
read-only
stringdate-time

When the counters were read: the end of the window

previousWindowStart
read-only
stringdate-time

Start of the previous window, seven days before windowStart

windowStart
read-only
stringdate-time

Start of the window: 00:00 UTC six days before today

400objectError 400 response
404objectError 404 response
500objectError 500 response

Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/usage \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "activity": { "bytesScanned": 0, "cpuTimeMilliseconds": 0, "daily": [ { "bytesScanned": 0, "cpuTimeMilliseconds": 0, "date": "2024-01-01T12:00:00Z", "elapsedMedianUpperBoundMilliseconds": 0, "elapsedP95UpperBoundMilliseconds": 0, "elapsedTotalMilliseconds": 0, "failedQueries": 0, "latencyScope": "QUERIES", "partial": true, "queries": 0, "statements": 0 } ], "elapsedMedianUpperBoundMilliseconds": 0, "elapsedP95UpperBoundMilliseconds": 0, "elapsedTotalMilliseconds": 0, "failedQueries": 0, "latencyBands": [ { "queries": 0, "upToMilliseconds": 0 } ], "latencyScope": "QUERIES", "previous": { "bytesScanned": 0, "cpuTimeMilliseconds": 0, "elapsedMedianUpperBoundMilliseconds": 0, "elapsedP95UpperBoundMilliseconds": 0, "elapsedTotalMilliseconds": 0, "failedQueries": 0, "latencyScope": "QUERIES", "queries": 0, "statements": 0 }, "queries": 0, "statements": 0 }, "catalogs": [ { "bytesScanned": 0, "catalogId": "00000000-0000-0000-0000-000000000000", "queries": 0, "storedBytes": 0 } ], "compute": [ { "bytesScanned": 0, "computePoolId": "00000000-0000-0000-0000-000000000000", "computeUnitSeconds": 0, "cpuTimeMilliseconds": 0, "elapsedMedianUpperBoundMilliseconds": 0, "elapsedP95UpperBoundMilliseconds": 0, "elapsedTotalMilliseconds": 0, "failedQueries": 0, "latencyScope": "QUERIES", "queries": 0, "statements": 0, "tier": "DEDICATED" } ], "countersSince": "2024-01-01T12:00:00Z", "dataSince": "2024-01-01T12:00:00Z", "dedicatedComputeMeasured": true, "generatedAt": "2024-01-01T12:00:00Z", "previousWindowStart": "2024-01-01T12:00:00Z", "windowStart": "2024-01-01T12:00:00Z"}

Get the connection details of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/connection

Returns everything a client needs to reach the lakehouse, except the credentials: the realm and the header carrying it, the Apache Iceberg REST catalog and its OAuth2 token service, the SQL endpoint and its JDBC and Trino URIs, the S3 endpoint and bucket, the data console when the region publishes one, and one entry per catalog with its warehouse name, the name the SQL endpoint serves it under and its JDBC and Trino URIs. The credentials come from a credential of a user: its client identifier and secret are the OAuth2 pair of every client and the user name and password of the SQL endpoint, and its S3 key, when it has one, signs the storage reads and writes.

The facts are those of the lakehouse: a lakehouse with a source-address allowlist is served on hosts of its own, which this call returns. Each section is null until the region reports it, and catalogs lists the READY catalogs the SQL endpoint serves, leaving out the catalogs being created or deleted: a client renders what is there and waits for the rest.

* S3 is a trademark filed by Amazon Technologies,Inc. OVHcloud's service is not sponsored by, endorsed by, or otherwise affiliated with Amazon Technologies,Inc.

Path parameters

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

Response

200Connectionsuccessful operation
catalogs
read-only
ConnectionCatalog[]

The READY catalogs of the lakehouse that the SQL endpoint serves, sorted by name. Catalogs being created or deleted are left out. Empty until the first catalog is READY and the SQL endpoint is published.

console
read-only
ConnectionConsole

The data console of the lakehouse. Null when the region publishes none, and until the region reports the endpoints of the lakehouse.

iceberg
read-only
ConnectionIceberg

How an Apache Iceberg client reaches the catalogs of the lakehouse. Null until the region reports the endpoints of the lakehouse.

realm
read-only
string

Realm of the lakehouse in the Apache Iceberg REST catalog of the region, the value your client sends in the header named by realmHeader. Null until the region reserves the realm.

realmHeader
read-only
string

Name of the HTTP header carrying the realm: Polaris-Realm

s3
read-only
ConnectionS3

How a client reaches the storage of the lakehouse, signing with the S3 key of a credential. Null until the region reports the bucket.

sql
read-only
ConnectionSql

How a SQL client reaches the SQL endpoint of the lakehouse. Null until the region reports the SQL endpoint.

400objectError 400 response
404objectError 404 response

Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/connection \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "catalogs": [ { "jdbcUri": "string", "name": "string", "sqlCatalog": "string", "trinoUri": "string", "warehouse": "string" } ], "console": { "uri": "string" }, "iceberg": { "scope": "PRINCIPAL_ROLE:ALL", "tokenUri": "string", "uri": "string" }, "realm": "string", "realmHeader": "string", "s3": { "bucket": "string", "endpoint": "string", "region": "eu-west-par" }, "sql": { "jdbcUri": "string", "trinoUri": "string", "uri": "string" }}